com.centrasite.jaxr.type
Interface CentraSiteRelationShipAttribute

All Superinterfaces:
CentraSiteAttribute

public interface CentraSiteRelationShipAttribute
extends CentraSiteAttribute

A RelationShip attribute is a specific kind of attribute whose value is represented by an Association. It is identified by an attribute-key that instances will use as a reference in order to be recognized as RelationShip attribute.


Field Summary
 
Fields inherited from interface com.centrasite.jaxr.type.CentraSiteAttribute
MAXOCCURS_1, MAXOCCURS_UNBOUNDED, MINOCCURS_0, MINOCCURS_1
 
Method Summary
 void addTargetType(javax.xml.registry.infomodel.Concept targetType)
          Add a target type to this relationship attribute.
 void addTargetTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> targetTypes)
          Add a collection of target types to this relationship attribute.
 javax.xml.registry.infomodel.Concept getAssociationType()
          Get this relationship attribute's association type.
 java.lang.String getAttributeKey()
          Get the attribute key.
 javax.xml.registry.infomodel.Concept getRelationShipType()
          Returns the relationship type defined for the relationship attribute
 java.util.Collection<javax.xml.registry.infomodel.Concept> getTargetTypes()
          Get the collection of target types for this relationship attribute.
 boolean isAggregation()
          Return whether this RelationShip attribute aggregates its target values.
 boolean isRequiredTarget()
          Return whether this Relationship attribute points to a required target object.
 boolean isReverseAggregation()
          Return whether this RelationShip attribute is reversely aggregated by its target values.
 void removeTargetType(javax.xml.registry.infomodel.Concept targetType)
          Remove a target type from this relationship attribute.
 void setAggregation(boolean aggregation)
          Set whether this RelationShip attribute aggregates its target values.
 void setAssociationType(javax.xml.registry.infomodel.Concept associationType)
          Set this relationship attribute's association type.
 void setRelationShipType(javax.xml.registry.infomodel.Concept relationShipType)
          Sets the relationship type of the relationship attribute
 void setRequiredTarget(boolean requiredTarget)
          Set whether this Relationship attribute points to a required target object.
 void setReverseAggregation(boolean aggregation)
          Set whether this RelationShip attribute is reversely aggregated by its target values.
 
Methods inherited from interface com.centrasite.jaxr.type.CentraSiteAttribute
getDefaultValue, getDescription, getDisplayName, getLocalName, getMaxOccurs, getMinOccurs, getName, hasDefaultValue, isReadOnly, isRequired, isSystemDefined, isUsed, setDefaultValue, setDescription, setMaxOccurs, setMinOccurs, setName, setReadOnly, setRequired
 

Method Detail

getAttributeKey

java.lang.String getAttributeKey()
                                 throws javax.xml.registry.JAXRException
Get the attribute key.

Returns:
the attribute key.
Throws:
javax.xml.registry.JAXRException

getTargetTypes

java.util.Collection<javax.xml.registry.infomodel.Concept> getTargetTypes()
                                                                          throws javax.xml.registry.JAXRException
Get the collection of target types for this relationship attribute.

Returns:
the collection of target types. Maybe empty but not null.
Throws:
javax.xml.registry.JAXRException

addTargetType

void addTargetType(javax.xml.registry.infomodel.Concept targetType)
                   throws javax.xml.registry.JAXRException
Add a target type to this relationship attribute.

Parameters:
targetType - type to be added
Throws:
javax.xml.registry.JAXRException

addTargetTypes

void addTargetTypes(java.util.Collection<javax.xml.registry.infomodel.Concept> targetTypes)
                    throws javax.xml.registry.JAXRException
Add a collection of target types to this relationship attribute.

Parameters:
targetTypes - collection of types to be added
Throws:
javax.xml.registry.JAXRException

removeTargetType

void removeTargetType(javax.xml.registry.infomodel.Concept targetType)
                      throws javax.xml.registry.JAXRException
Remove a target type from this relationship attribute.

Parameters:
targetType - the type to be removed
Throws:
javax.xml.registry.JAXRException

getAssociationType

javax.xml.registry.infomodel.Concept getAssociationType()
                                                        throws javax.xml.registry.JAXRException
Get this relationship attribute's association type.

Returns:
the association type
Throws:
javax.xml.registry.JAXRException

setAssociationType

void setAssociationType(javax.xml.registry.infomodel.Concept associationType)
                        throws javax.xml.registry.JAXRException
Set this relationship attribute's association type.

Parameters:
associationType -
Throws:
javax.xml.registry.JAXRException

isAggregation

boolean isAggregation()
                      throws javax.xml.registry.JAXRException
Return whether this RelationShip attribute aggregates its target values.

Returns:
true if this RelationShip attribute aggregates its target values.
Throws:
javax.xml.registry.JAXRException

setAggregation

void setAggregation(boolean aggregation)
                    throws javax.xml.registry.JAXRException
Set whether this RelationShip attribute aggregates its target values.

Parameters:
aggregation - true if this RelationShip attribute aggregates its target values.
Throws:
javax.xml.registry.JAXRException

isReverseAggregation

boolean isReverseAggregation()
                             throws javax.xml.registry.JAXRException
Return whether this RelationShip attribute is reversely aggregated by its target values.

Returns:
true if this RelationShip attribute is reversely aggregated by its target values.
Throws:
javax.xml.registry.JAXRException

setReverseAggregation

void setReverseAggregation(boolean aggregation)
                           throws javax.xml.registry.JAXRException
Set whether this RelationShip attribute is reversely aggregated by its target values.

Parameters:
aggregation - true if this RelationShip attribute is reversely aggregated by its target values.
Throws:
javax.xml.registry.JAXRException

isRequiredTarget

boolean isRequiredTarget()
                         throws javax.xml.registry.JAXRException
Return whether this Relationship attribute points to a required target object.

Returns:
true if this Relationship attribute points to a required target object.
Throws:
javax.xml.registry.JAXRException

setRequiredTarget

void setRequiredTarget(boolean requiredTarget)
                       throws javax.xml.registry.JAXRException
Set whether this Relationship attribute points to a required target object.

Parameters:
requiredTarget - true if this Relationship attribute points to a required target object.
Throws:
javax.xml.registry.JAXRException

setRelationShipType

void setRelationShipType(javax.xml.registry.infomodel.Concept relationShipType)
                         throws javax.xml.registry.JAXRException
Sets the relationship type of the relationship attribute

Parameters:
relationshipType - JAXR concept representing the relationship type
Throws:
javax.xml.registry.JAXRException

getRelationShipType

javax.xml.registry.infomodel.Concept getRelationShipType()
                                                         throws javax.xml.registry.JAXRException
Returns the relationship type defined for the relationship attribute

Returns:
JAXR Concept representing the relationShipType
Throws:
javax.xml.registry.JAXRException