|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CentraSiteRegistryObject
CentraSite extension of RegistryObject.
RegistryObject
Method Summary | |
---|---|
void |
accept(CentraSiteRegistryObjectVisitor visitor)
Accept a CentraSiteRegistryObjectVisitor |
void |
addAuditComment(java.lang.String comment)
Add a comment which will be attached to the next auditable event for that object. |
void |
addPostListener(java.lang.String listenerName,
CentraSiteRegistryObjectListener postListener)
Adds the given listener as 'POST' listener for this registry object with the given name. |
void |
addPreListener(java.lang.String listenerName,
CentraSiteRegistryObjectListener preListener)
Adds the given listener as 'PRE' listener for this registry object with the given name. |
CentraSiteACL |
getCentraSiteACL()
Get the CentraSiteACL. |
java.util.Collection<java.lang.Object> |
getClassificationValue(CentraSiteClassificationAttribute ca)
Get the value for the given Classification attribute. |
java.sql.Timestamp |
getCreationDate()
Return the creation date of this RegistryObject. |
InstanceLevelPrivilege |
getCurrentUserPrivilege()
Get the Privilege of the current user for this RegistryObject. |
java.util.Collection<javax.xml.registry.infomodel.AuditableEvent> |
getEmbeddedAuditTrail()
Get this RegistryObject's AuditTrail, as well as the AuditTrail of all embedded objects like classifications and associations. |
CentraSiteRegistryObject |
getEnclosingObject()
Return the enclosing object. |
java.util.Collection<javax.xml.registry.infomodel.ExternalLink> |
getFileAsExternalLink(CentraSiteFileAttribute fa)
Get the value for the given File attribute. |
java.util.Collection<java.lang.String> |
getFileValue(CentraSiteFileAttribute fa)
Get the value for the given File attribute. |
InstanceLevelPermissionSet |
getInstanceLevelPermissionSet()
Get the InstanceLevelPermissionSet for this RegistryObject. |
java.sql.Timestamp |
getLastModificationDate()
Return the last-modification date of this RegistryObject. |
javax.xml.registry.infomodel.User |
getOwner()
Get this object's owner |
javax.xml.registry.infomodel.User |
getPreviousOwner()
Get this object's previous owner. |
javax.xml.registry.infomodel.Organization |
getPreviousSubmittingOrganization()
Get this object's previous submitting organization. |
java.util.Collection<javax.xml.registry.infomodel.RegistryObject> |
getRelationShipValue(CentraSiteRelationShipAttribute ra)
Get the value for the given RelationShip attribute. |
long |
getServerTimezoneOffset()
Deprecated. |
java.lang.String |
getSubmittingOrganizationKey()
Get the key/id of the object's submittingOrganization |
javax.xml.registry.infomodel.Concept |
getVirtualObjectType()
Return the virtual object type concept of this RegistryObject. |
boolean |
isAclModified()
Return whether this object's acl has been modified. |
boolean |
isAssociatedTo(java.lang.String targetObjectId,
java.lang.String associationTypeId)
Return whether this RegistryObject is associated to a RegistryObject with the given id and with the particular association type. |
boolean |
isClassifiedWith(java.lang.String conceptId)
Return whether this RegistryObject is classified with a concept with the given id. |
boolean |
isDeleted()
return whether this object has been deleted |
boolean |
isDescendantObjectModified()
Return whether one of this object's descendant objects has been modified. |
boolean |
isInternal()
Return whether this RegistryObject is marked as internal. |
boolean |
isLocked()
Return true if the connection that owns this object has acquired an exclusive lock for the object. |
boolean |
isModified()
Return true if this object has modifications that have not yet been saved. |
boolean |
isModifiedByUser()
Check whether this object was modified by a user different from the DefaultUser. |
boolean |
isMoved()
Return whether this RegistryObject is being moved to a new owner or to a new organization. |
boolean |
isMoveOrganization()
Return whether this RegistryObject is being moved to a new organization. |
boolean |
isMoveOwner()
Return whether this RegistryObject is being moved to a new owner. |
boolean |
isObjectModified()
Return whether this object has been modified. |
boolean |
isPermissionModified()
Return whether this object's permission set has been modified. |
boolean |
isPredefined()
Return whether this is a pre-defined object. |
boolean |
isPropagatePermissions()
Returns weather this object is enabled with the instance level permission propagation to its dependent objects. |
boolean |
isPropagateProfilePermissions()
Returns weather this object is enabled with the profile level permission propagation to its dependent objects. |
boolean |
isRevisionObject()
Return whether this object is a revisioned one. |
void |
logLCStateChange(javax.xml.registry.infomodel.Concept previousState,
javax.xml.registry.infomodel.Concept nextState)
Log an LC state change in the RegistryObject's audit trail. |
void |
removeExternalLinkId(java.lang.String externalLinkId)
Remove the external link reference from an object. |
void |
setCentraSiteACL(CentraSiteACL acl)
Set the CentraSiteACL. |
void |
setClassificationValue(CentraSiteClassificationAttribute ca,
java.util.Collection<java.lang.Object> values)
Set the value for the given Classification attribute. |
void |
setFileValue(CentraSiteFileAttribute fa,
java.util.Collection<java.lang.String> uris)
Set the value for the given File attribute. |
void |
setFileValue(CentraSiteFileAttribute fa,
java.util.Collection<java.lang.String> uris,
boolean isOwningObject)
|
void |
setFileWithExternalLink(CentraSiteFileAttribute fa,
java.util.Collection<javax.xml.registry.infomodel.ExternalLink> externallinks)
Set the value for the given File attribute. |
void |
setFileWithExternalLink(CentraSiteFileAttribute fa,
java.util.Collection<javax.xml.registry.infomodel.ExternalLink> externallinks,
boolean isOwningObject)
|
void |
setInstanceLevelPermissionSet(InstanceLevelPermissionSet permissionSet)
Set the InstanceLevelPermissionSet for this RegistryObject. |
void |
setInternal(boolean internal)
Set the internal status of this RegistryObject to the given value. |
void |
setLocked(boolean locked)
Set the object's locking status. |
void |
setOwner(javax.xml.registry.infomodel.User owner)
Set this object's owner |
void |
setPropagatePermissions(boolean propagatePermissions)
Enable or Disable permission propagation option on a RegistryObject to its dependent objects |
void |
setPropagateProfilePermissions(boolean propagateProfilePermissions)
Enable or Disable profile permission propagation option on a RegistryObject to its dependent objects |
void |
setRelationShipValue(CentraSiteRelationShipAttribute ra,
java.util.Collection<javax.xml.registry.infomodel.RegistryObject> targets)
Set the value for the given RelationShip attribute. |
void |
setSubmittingOrganization(javax.xml.registry.infomodel.Organization organization)
Set default submitting organization. |
java.lang.String |
toXMLforExport()
Generate XML representation for export. |
java.lang.String |
toXMLforExport(java.util.Collection<java.lang.Integer> exportQualifiers)
Generate XML representation for export. |
Methods inherited from interface com.centrasite.jaxr.infomodel.CentraSiteExtensibleObject |
---|
getRegistryService |
Methods inherited from interface javax.xml.registry.infomodel.RegistryObject |
---|
addAssociation, addAssociations, addClassification, addClassifications, addExternalIdentifier, addExternalIdentifiers, addExternalLink, addExternalLinks, getAssociatedObjects, getAssociations, getAuditTrail, getClassifications, getDescription, getExternalIdentifiers, getExternalLinks, getKey, getLifeCycleManager, getName, getObjectType, getRegistryPackages, getSubmittingOrganization, removeAssociation, removeAssociations, removeClassification, removeClassifications, removeExternalIdentifier, removeExternalIdentifiers, removeExternalLink, removeExternalLinks, setAssociations, setClassifications, setDescription, setExternalIdentifiers, setExternalLinks, setKey, setName, toXML |
Methods inherited from interface javax.xml.registry.infomodel.ExtensibleObject |
---|
addSlot, addSlots, getSlot, getSlots, removeSlot, removeSlots |
Method Detail |
---|
void addAuditComment(java.lang.String comment) throws javax.xml.registry.JAXRException
comment
- the comment to be added. Ignored if null.
javax.xml.registry.JAXRException
boolean isAclModified()
boolean isPermissionModified() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
boolean isDescendantObjectModified()
boolean isObjectModified()
boolean isMoveOwner() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
boolean isMoveOrganization() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
boolean isMoved() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
boolean isPredefined() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
boolean isDeleted()
boolean isRevisionObject()
CentraSiteRegistryObject getEnclosingObject() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
javax.xml.registry.infomodel.User getOwner() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
javax.xml.registry.infomodel.User getPreviousOwner() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
CentraSiteACL getCentraSiteACL() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setCentraSiteACL(CentraSiteACL acl) throws javax.xml.registry.JAXRException
acl
- the CentraSiteACL
javax.xml.registry.JAXRException
InstanceLevelPermissionSet getInstanceLevelPermissionSet() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setInstanceLevelPermissionSet(InstanceLevelPermissionSet permissionSet) throws javax.xml.registry.JAXRException
permissionSet
- the InstanceLevelPermissionSet for this RegistryObject
javax.xml.registry.JAXRException
InstanceLevelPrivilege getCurrentUserPrivilege() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setLocked(boolean locked) throws javax.xml.registry.JAXRException
locked
- true if object is locked
javax.xml.registry.JAXRException
void setOwner(javax.xml.registry.infomodel.User owner) throws javax.xml.registry.JAXRException
owner
- this object's owner
javax.xml.registry.JAXRException
java.lang.String toXMLforExport() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
java.lang.String toXMLforExport(java.util.Collection<java.lang.Integer> exportQualifiers) throws javax.xml.registry.JAXRException
exportQualifiers
- a collection of ExportQualifiers. Must not be null.
javax.xml.registry.JAXRException
void accept(CentraSiteRegistryObjectVisitor visitor) throws javax.xml.registry.JAXRException
visitor
- a CentraSiteRegistryObjectVisitor
javax.xml.registry.JAXRException
boolean isInternal() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setInternal(boolean internal) throws javax.xml.registry.JAXRException
internal
- true if this RegistryObject is to be marked as internal, false otherwise
javax.xml.registry.JAXRException
boolean isClassifiedWith(java.lang.String conceptId) throws javax.xml.registry.JAXRException
conceptId
- the concept id to be checked
javax.xml.registry.JAXRException
boolean isAssociatedTo(java.lang.String targetObjectId, java.lang.String associationTypeId) throws javax.xml.registry.JAXRException
targetObjectId
- associationTypeId
-
javax.xml.registry.JAXRException
java.sql.Timestamp getCreationDate() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
java.sql.Timestamp getLastModificationDate() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
long getServerTimezoneOffset() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setSubmittingOrganization(javax.xml.registry.infomodel.Organization organization) throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if a registry error occursjava.lang.String getSubmittingOrganizationKey()
javax.xml.registry.infomodel.Organization getPreviousSubmittingOrganization() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
java.util.Collection<javax.xml.registry.infomodel.AuditableEvent> getEmbeddedAuditTrail() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setRelationShipValue(CentraSiteRelationShipAttribute ra, java.util.Collection<javax.xml.registry.infomodel.RegistryObject> targets) throws javax.xml.registry.JAXRException
ra
- the CentraSiteRelationShipAttribute for which the value is to be set.targets
- the attribute value as a collection of RegistryObjects. Maybe empty or null.
javax.xml.registry.JAXRException
java.util.Collection<javax.xml.registry.infomodel.RegistryObject> getRelationShipValue(CentraSiteRelationShipAttribute ra) throws javax.xml.registry.JAXRException
ra
- the CentraSiteRelationShipAttribute
javax.xml.registry.JAXRException
void setFileValue(CentraSiteFileAttribute fa, java.util.Collection<java.lang.String> uris) throws javax.xml.registry.JAXRException
fa
- the CentraSiteFileAttribute for which the value is to be set.uris
- the attribute value as a collection of URI strings. Maybe empty or null.
javax.xml.registry.JAXRException
void setFileValue(CentraSiteFileAttribute fa, java.util.Collection<java.lang.String> uris, boolean isOwningObject) throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
java.util.Collection<java.lang.String> getFileValue(CentraSiteFileAttribute fa) throws javax.xml.registry.JAXRException
fa
- the CentraSiteFileAttribute
javax.xml.registry.JAXRException
void setFileWithExternalLink(CentraSiteFileAttribute fa, java.util.Collection<javax.xml.registry.infomodel.ExternalLink> externallinks) throws javax.xml.registry.JAXRException
fa
- the CentraSiteFileAttribute for which the value is to be set.externallinks
- the attribute value as a collection of ExternalLinks. Maybe empty or null.
javax.xml.registry.JAXRException
void setFileWithExternalLink(CentraSiteFileAttribute fa, java.util.Collection<javax.xml.registry.infomodel.ExternalLink> externallinks, boolean isOwningObject) throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
java.util.Collection<javax.xml.registry.infomodel.ExternalLink> getFileAsExternalLink(CentraSiteFileAttribute fa) throws javax.xml.registry.JAXRException
fa
- the CentraSiteFileAttribute
javax.xml.registry.JAXRException
void setClassificationValue(CentraSiteClassificationAttribute ca, java.util.Collection<java.lang.Object> values) throws javax.xml.registry.JAXRException
ca
- the CentraSiteClassificationAttribute for which the value is to be set.values
- the attribute value as a collection of concepts or strings. Maybe empty or null.
javax.xml.registry.JAXRException
java.util.Collection<java.lang.Object> getClassificationValue(CentraSiteClassificationAttribute ca) throws javax.xml.registry.JAXRException
ca
- the CentraSiteClassificationAttribute
javax.xml.registry.JAXRException
javax.xml.registry.infomodel.Concept getVirtualObjectType() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void logLCStateChange(javax.xml.registry.infomodel.Concept previousState, javax.xml.registry.infomodel.Concept nextState) throws javax.xml.registry.JAXRException
previousState
- the previous state, null when setting the initial statenextState
- the next state
javax.xml.registry.JAXRException
boolean isModifiedByUser() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
boolean isModified() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
boolean isLocked() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void removeExternalLinkId(java.lang.String externalLinkId) throws javax.xml.registry.JAXRException
externalLinkId
- the reference (id) of the external link to be removed
javax.xml.registry.JAXRException
void addPreListener(java.lang.String listenerName, CentraSiteRegistryObjectListener preListener) throws javax.xml.registry.JAXRException
listenerName
- listener name used to associate/retrieve
CentraSiteRegistryObjectListener instance.preListener
- CentraSiteRegistryObjectListener instance encapsulate the
steps need to execute.
javax.xml.registry.JAXRException
void addPostListener(java.lang.String listenerName, CentraSiteRegistryObjectListener postListener) throws javax.xml.registry.JAXRException
listenerName
- listener name used to associate/retrieve
CentraSiteRegistryObjectListener instance.postListener
- CentraSiteRegistryObjectListener instance encapsulate the
steps need to execute.
javax.xml.registry.JAXRException
void setPropagatePermissions(boolean propagatePermissions) throws javax.xml.registry.JAXRException
propagatePermissions
-
javax.xml.registry.JAXRException
boolean isPropagatePermissions() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
void setPropagateProfilePermissions(boolean propagateProfilePermissions) throws javax.xml.registry.JAXRException
propagateProfilePermissions
-
javax.xml.registry.JAXRException
boolean isPropagateProfilePermissions() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |