|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.mayo.edu.lgModel.LexGridBase
org.LexGrid.commonTypes.Versionable
org.LexGrid.REST.relations.AssociatableElement
public class AssociatableElement
Information common to both the entity and data form of the "to" (or right hand) side of an association.
Constructor Summary | |
---|---|
AssociatableElement()
|
Method Summary | |
---|---|
void |
addAssociationQualification(AssociationQualification vAssociationQualification)
|
void |
addAssociationQualification(int index,
AssociationQualification vAssociationQualification)
|
void |
addUsageContext(Context vUsageContext)
|
void |
addUsageContext(int index,
Context vUsageContext)
|
java.util.Enumeration<? extends AssociationQualification> |
enumerateAssociationQualification()
Method enumerateAssociationQualification. |
java.util.Enumeration<? extends Context> |
enumerateUsageContext()
Method enumerateUsageContext. |
java.lang.String |
getAssociationInstanceId()
Returns the value of field 'associationInstanceId'. |
AssociationQualification[] |
getAssociationQualification()
Method getAssociationQualification.Returns the contents of the collection in an Array. |
AssociationQualification |
getAssociationQualification(int index)
Method getAssociationQualification. |
java.util.List<AssociationQualification> |
getAssociationQualificationAsReference()
Method getAssociationQualificationAsReference.Returns a reference to '_associationQualificationList'. |
int |
getAssociationQualificationCount()
Method getAssociationQualificationCount. |
java.lang.Boolean |
getIdIsPublic()
Returns the value of field 'idIsPublic'. |
java.lang.Boolean |
getIsDefining()
Returns the value of field 'isDefining'. |
java.lang.Boolean |
getIsInferred()
Returns the value of field 'isInferred'. |
Context[] |
getUsageContext()
Method getUsageContext.Returns the contents of the collection in an Array. |
Context |
getUsageContext(int index)
Method getUsageContext. |
java.util.List<Context> |
getUsageContextAsReference()
Method getUsageContextAsReference.Returns a reference to '_usageContextList'. |
int |
getUsageContextCount()
Method getUsageContextCount. |
java.lang.Boolean |
isIdIsPublic()
Returns the value of field 'idIsPublic'. |
java.lang.Boolean |
isIsDefining()
Returns the value of field 'isDefining'. |
java.lang.Boolean |
isIsInferred()
Returns the value of field 'isInferred'. |
boolean |
isValid()
Method isValid. |
java.util.Iterator<? extends AssociationQualification> |
iterateAssociationQualification()
Method iterateAssociationQualification. |
java.util.Iterator<? extends Context> |
iterateUsageContext()
Method iterateUsageContext. |
void |
marshal(org.xml.sax.ContentHandler handler)
|
void |
marshal(java.io.Writer out)
|
void |
removeAllAssociationQualification()
|
void |
removeAllUsageContext()
|
boolean |
removeAssociationQualification(AssociationQualification vAssociationQualification)
Method removeAssociationQualification. |
AssociationQualification |
removeAssociationQualificationAt(int index)
Method removeAssociationQualificationAt. |
boolean |
removeUsageContext(Context vUsageContext)
Method removeUsageContext. |
Context |
removeUsageContextAt(int index)
Method removeUsageContextAt. |
void |
setAssociationInstanceId(java.lang.String associationInstanceId)
Sets the value of field 'associationInstanceId'. |
void |
setAssociationQualification(AssociationQualification[] vAssociationQualificationArray)
|
void |
setAssociationQualification(int index,
AssociationQualification vAssociationQualification)
|
void |
setAssociationQualification(java.util.List<AssociationQualification> vAssociationQualificationList)
Sets the value of '_associationQualificationList' by copying the given Vector. |
void |
setAssociationQualificationAsReference(java.util.List<AssociationQualification> associationQualificationList)
Deprecated. |
void |
setIdIsPublic(java.lang.Boolean idIsPublic)
Sets the value of field 'idIsPublic'. |
void |
setIsDefining(java.lang.Boolean isDefining)
Sets the value of field 'isDefining'. |
void |
setIsInferred(java.lang.Boolean isInferred)
Sets the value of field 'isInferred'. |
void |
setUsageContext(Context[] vUsageContextArray)
|
void |
setUsageContext(int index,
Context vUsageContext)
|
void |
setUsageContext(java.util.List<Context> vUsageContextList)
Sets the value of '_usageContextList' by copying the given Vector. |
void |
setUsageContextAsReference(java.util.List<Context> usageContextList)
Deprecated. |
static AssociatableElement |
unmarshalAssociatableElement(java.io.Reader reader)
Method unmarshalAssociatableElement. |
void |
validate()
|
Methods inherited from class org.LexGrid.commonTypes.Versionable |
---|
getEffectiveDate, getEntryState, getExpirationDate, getIsActive, getOwner, getStatus, isIsActive, setEffectiveDate, setEntryState, setExpirationDate, setIsActive, setOwner, setStatus, unmarshalVersionable |
Methods inherited from class org.mayo.edu.lgModel.LexGridBase |
---|
getParent, setParent |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AssociatableElement()
Method Detail |
---|
public void addAssociationQualification(AssociationQualification vAssociationQualification) throws java.lang.IndexOutOfBoundsException
vAssociationQualification
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addAssociationQualification(int index, AssociationQualification vAssociationQualification) throws java.lang.IndexOutOfBoundsException
index
- vAssociationQualification
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addUsageContext(Context vUsageContext) throws java.lang.IndexOutOfBoundsException
vUsageContext
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void addUsageContext(int index, Context vUsageContext) throws java.lang.IndexOutOfBoundsException
index
- vUsageContext
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic java.util.Enumeration<? extends AssociationQualification> enumerateAssociationQualification()
public java.util.Enumeration<? extends Context> enumerateUsageContext()
public java.lang.String getAssociationInstanceId()
public AssociationQualification getAssociationQualification(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic AssociationQualification[] getAssociationQualification()
Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
public java.util.List<AssociationQualification> getAssociationQualificationAsReference()
public int getAssociationQualificationCount()
public java.lang.Boolean getIdIsPublic()
public java.lang.Boolean getIsDefining()
public java.lang.Boolean getIsInferred()
public Context getUsageContext(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic Context[] getUsageContext()
Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.
public java.util.List<Context> getUsageContextAsReference()
public int getUsageContextCount()
public java.lang.Boolean isIdIsPublic()
public java.lang.Boolean isIsDefining()
public java.lang.Boolean isIsInferred()
public boolean isValid()
isValid
in class Versionable
public java.util.Iterator<? extends AssociationQualification> iterateAssociationQualification()
public java.util.Iterator<? extends Context> iterateUsageContext()
public void marshal(java.io.Writer out) throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
marshal
in class Versionable
out
-
org.exolab.castor.xml.MarshalException
- if object is
null or if any SAXException is thrown during marshaling
org.exolab.castor.xml.ValidationException
- if this
object is an invalid instance according to the schemapublic void marshal(org.xml.sax.ContentHandler handler) throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
marshal
in class Versionable
handler
-
java.io.IOException
- if an IOException occurs during
marshaling
org.exolab.castor.xml.ValidationException
- if this
object is an invalid instance according to the schema
org.exolab.castor.xml.MarshalException
- if object is
null or if any SAXException is thrown during marshalingpublic void removeAllAssociationQualification()
public void removeAllUsageContext()
public boolean removeAssociationQualification(AssociationQualification vAssociationQualification)
vAssociationQualification
-
public AssociationQualification removeAssociationQualificationAt(int index)
index
-
public boolean removeUsageContext(Context vUsageContext)
vUsageContext
-
public Context removeUsageContextAt(int index)
index
-
public void setAssociationInstanceId(java.lang.String associationInstanceId)
associationInstanceId
- the value of field
'associationInstanceId'.public void setAssociationQualification(int index, AssociationQualification vAssociationQualification) throws java.lang.IndexOutOfBoundsException
index
- vAssociationQualification
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setAssociationQualification(AssociationQualification[] vAssociationQualificationArray)
vAssociationQualificationArray
- public void setAssociationQualification(java.util.List<AssociationQualification> vAssociationQualificationList)
vAssociationQualificationList
- the Vector to copy.public void setAssociationQualificationAsReference(java.util.List<AssociationQualification> associationQualificationList)
associationQualificationList
- the Vector to set.public void setIdIsPublic(java.lang.Boolean idIsPublic)
idIsPublic
- the value of field 'idIsPublic'.public void setIsDefining(java.lang.Boolean isDefining)
isDefining
- the value of field 'isDefining'.public void setIsInferred(java.lang.Boolean isInferred)
isInferred
- the value of field 'isInferred'.public void setUsageContext(int index, Context vUsageContext) throws java.lang.IndexOutOfBoundsException
index
- vUsageContext
-
java.lang.IndexOutOfBoundsException
- if the index
given is outside the bounds of the collectionpublic void setUsageContext(Context[] vUsageContextArray)
vUsageContextArray
- public void setUsageContext(java.util.List<Context> vUsageContextList)
vUsageContextList
- the Vector to copy.public void setUsageContextAsReference(java.util.List<Context> usageContextList)
usageContextList
- the Vector to set.public static AssociatableElement unmarshalAssociatableElement(java.io.Reader reader) throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
reader
-
org.exolab.castor.xml.MarshalException
- if object is
null or if any SAXException is thrown during marshaling
org.exolab.castor.xml.ValidationException
- if this
object is an invalid instance according to the schemapublic void validate() throws org.exolab.castor.xml.ValidationException
validate
in class Versionable
org.exolab.castor.xml.ValidationException
- if this
object is an invalid instance according to the schema
|
Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |