public interface CentraSiteRegistryObject extends CentraSiteExtensibleObject, javax.xml.registry.infomodel.RegistryObject
RegistryObject
Modifier and Type | Method and Description |
---|---|
void |
accept(CentraSiteRegistryObjectVisitor visitor)
Accepts a CentraSiteRegistryObjectVisitor.
|
void |
addAuditComment(java.lang.String comment)
Adds a comment which will be attached to the next auditable event for that object.
|
javax.xml.registry.infomodel.AuditableEvent |
addCustomAuditableEvent()
Creates and returns a auditable event with
event type being CUSTOM
owner would be the caller
applied object would be this registyobject.
|
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()
Gets the CentraSiteACL.
|
java.util.Collection<java.lang.Object> |
getClassificationValue(CentraSiteClassificationAttribute ca)
Gets the value for the given Classification attribute.
|
java.sql.Timestamp |
getCreationDate()
Returns the creation date of this RegistryObject.
|
InstanceLevelPrivilege |
getCurrentUserPrivilege()
Gets the Privilege of the current user for this RegistryObject.
|
java.util.Collection<javax.xml.registry.infomodel.AuditableEvent> |
getEmbeddedAuditTrail()
Gets this RegistryObject's AuditTrail, as well as the AuditTrail of all embedded
objects like classifications and associations.
|
CentraSiteRegistryObject |
getEnclosingObject()
Returns the enclosing object.
|
java.util.Collection<javax.xml.registry.infomodel.ExternalLink> |
getFileAsExternalLink(CentraSiteFileAttribute fa)
Gets the value for the given File attribute.
|
java.util.Collection<java.lang.String> |
getFileValue(CentraSiteFileAttribute fa)
Gets the value for the given File attribute.
|
InstanceLevelPermissionSet |
getInstanceLevelPermissionSet()
Gets the InstanceLevelPermissionSet for this RegistryObject.
|
java.sql.Timestamp |
getLastModificationDate()
Returns the last-modification date of this RegistryObject.
|
javax.xml.registry.infomodel.User |
getOwner()
Gets this object's owner.
|
javax.xml.registry.infomodel.User |
getPreviousOwner()
Gets this object's previous owner.
|
javax.xml.registry.infomodel.Organization |
getPreviousSubmittingOrganization()
Gets current object's previous submitting organization.
|
java.util.Collection<javax.xml.registry.infomodel.RegistryObject> |
getRelationShipValue(CentraSiteRelationShipAttribute ra)
Gets the value for the given RelationShip attribute.
|
long |
getServerTimezoneOffset()
Deprecated.
|
java.lang.String |
getSubmittingOrganizationKey()
Gets the key/id of the object's submittingOrganization.
|
javax.xml.registry.infomodel.Concept |
getVirtualObjectType()
Returns the virtual object type concept of this RegistryObject.
|
boolean |
isAclModified()
Returns whether this object's acl has been modified.
|
boolean |
isAssociatedTo(java.lang.String targetObjectId,
java.lang.String associationTypeId)
Returns whether this RegistryObject is associated to a RegistryObject with the given ID and with the particular association type.
|
boolean |
isClassifiedWith(java.lang.String conceptId)
Returns whether this RegistryObject is classified with a concept with the given id.
|
boolean |
isDeleted()
Returns whether this object has been deleted.
|
boolean |
isDescendantObjectModified()
Returns whether one of this object's descendant objects has been modified.
|
boolean |
isInternal()
Returns whether this RegistryObject is marked as internal.
|
boolean |
isLocked()
Returns true if the connection that owns this object has acquired an exclusive
lock for the object.
|
boolean |
isModified()
Returns true if this object has modifications that have not yet been saved.
|
boolean |
isModifiedByUser()
Checks whether this object was modified by a user different from the DefaultUser.
|
boolean |
isMoved()
Returns whether this RegistryObject is being moved to a new owner or to a new organization.
|
boolean |
isMoveOrganization()
Returns whether this RegistryObject is being moved to a new organization.
|
boolean |
isMoveOwner()
Returns whether this RegistryObject is being moved to a new owner.
|
boolean |
isObjectModified()
Returns whether this object has been modified.
|
boolean |
isPermissionModified()
Returns whether this object's permission set has been modified.
|
boolean |
isPredefined()
Returns 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()
Returns whether this object is a revisioned one.
|
void |
logLCStateChange(javax.xml.registry.infomodel.Concept previousState,
javax.xml.registry.infomodel.Concept nextState)
Logs an LC state change in the RegistryObject's audit trail.
|
void |
removeExternalLinkId(java.lang.String externalLinkId)
Removes the external link reference from an object.
|
void |
setCentraSiteACL(CentraSiteACL acl)
Sets the CentraSiteACL.
|
void |
setClassificationValue(CentraSiteClassificationAttribute ca,
java.util.Collection<java.lang.Object> values)
Sets the value for the given Classification attribute.
|
void |
setFileValue(CentraSiteFileAttribute fa,
java.util.Collection<java.lang.String> uris)
Sets the value for the given File attribute.
|
void |
setFileValue(CentraSiteFileAttribute fa,
java.util.Collection<java.lang.String> uris,
boolean isOwningObject)
Sets the value for the given File attribute.
|
void |
setFileWithExternalLink(CentraSiteFileAttribute fa,
java.util.Collection<javax.xml.registry.infomodel.ExternalLink> externallinks)
Sets the value for the given File attribute.
|
void |
setFileWithExternalLink(CentraSiteFileAttribute fa,
java.util.Collection<javax.xml.registry.infomodel.ExternalLink> externallinks,
boolean isOwningObject)
Sets the value for the given File attribute.
|
void |
setInstanceLevelPermissionSet(InstanceLevelPermissionSet permissionSet)
Sets the InstanceLevelPermissionSet for this RegistryObject.
|
void |
setInternal(boolean internal)
Sets the internal status of this RegistryObject to the given value.
|
void |
setLocked(boolean locked)
Sets the object's locking status.
|
void |
setOwner(javax.xml.registry.infomodel.User owner)
Sets this object's owner.
|
void |
setPropagatePermissions(boolean propagatePermissions)
Enables or Disables permission propagation option on a RegistryObject to its dependent objects.
|
void |
setPropagateProfilePermissions(boolean propagateProfilePermissions)
Enables or Disables profile permission propagation option on a RegistryObject to its dependent objects.
|
void |
setRelationShipValue(CentraSiteRelationShipAttribute ra,
java.util.Collection<javax.xml.registry.infomodel.RegistryObject> targets)
Sets the value for the given RelationShip attribute.
|
void |
setSubmittingOrganization(javax.xml.registry.infomodel.Organization organization)
Sets default submitting organization.
|
java.lang.String |
toXMLforExport()
Generates XML representation for export.
|
java.lang.String |
toXMLforExport(java.util.Collection<java.lang.Integer> exportQualifiers)
Generates XML representation for export.
|
getRegistryService
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
void addAuditComment(java.lang.String comment) throws javax.xml.registry.JAXRException
comment
- the comment to be added. Ignored if null.javax.xml.registry.JAXRException
- if an internal error occurs on adding the audit commentboolean isAclModified()
boolean isPermissionModified() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on modifying the object's permissionboolean isDescendantObjectModified()
boolean isObjectModified()
boolean isMoveOwner() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on moving to a new owner.boolean isMoveOrganization() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on moving to a new organization.boolean isMoved() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on moving to a new organization or to a new owner.boolean isPredefined() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occursboolean isDeleted()
boolean isRevisionObject()
CentraSiteRegistryObject getEnclosingObject() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the enclosing object.javax.xml.registry.infomodel.User getOwner() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the object's owner.javax.xml.registry.infomodel.User getPreviousOwner() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the object's previous owner.CentraSiteACL getCentraSiteACL() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the CentraSiteACL object.void setCentraSiteACL(CentraSiteACL acl) throws javax.xml.registry.JAXRException
acl
- the CentraSiteACLjavax.xml.registry.JAXRException
- if an internal error occurs on setting the CentraSiteACL object.InstanceLevelPermissionSet getInstanceLevelPermissionSet() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the InstanceLevelPermissionSet.void setInstanceLevelPermissionSet(InstanceLevelPermissionSet permissionSet) throws javax.xml.registry.JAXRException
permissionSet
- the InstanceLevelPermissionSet for this RegistryObjectjavax.xml.registry.JAXRException
- if an internal error occurs on setting the InstanceLevelPermissionSet.InstanceLevelPrivilege getCurrentUserPrivilege() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the Privilege of the current user.void setLocked(boolean locked) throws javax.xml.registry.JAXRException
locked
- true if object is lockedjavax.xml.registry.JAXRException
- if an internal error occursvoid setOwner(javax.xml.registry.infomodel.User owner) throws javax.xml.registry.JAXRException
owner
- this object's ownerjavax.xml.registry.JAXRException
- if an internal error occursjava.lang.String toXMLforExport() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs.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
- if an internal error occursvoid accept(CentraSiteRegistryObjectVisitor visitor) throws javax.xml.registry.JAXRException
visitor
- a CentraSiteRegistryObjectVisitorjavax.xml.registry.JAXRException
- if an internal error occursboolean isInternal() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occursvoid setInternal(boolean internal) throws javax.xml.registry.JAXRException
internal
- true if this RegistryObject is to be marked as internal, false otherwisejavax.xml.registry.JAXRException
- if an internal error occursboolean isClassifiedWith(java.lang.String conceptId) throws javax.xml.registry.JAXRException
conceptId
- the concept id to be checkedjavax.xml.registry.JAXRException
- if an internal error occursboolean isAssociatedTo(java.lang.String targetObjectId, java.lang.String associationTypeId) throws javax.xml.registry.JAXRException
targetObjectId
- the target object ID.associationTypeId
- the associated type ID to check against.javax.xml.registry.JAXRException
- if an internal error occursjava.sql.Timestamp getCreationDate() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the creation datejava.sql.Timestamp getLastModificationDate() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the last-modification datelong getServerTimezoneOffset() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occursvoid setSubmittingOrganization(javax.xml.registry.infomodel.Organization organization) throws javax.xml.registry.JAXRException
organization
- the Organization
object.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
- if an internal error occurs on retrieving the previous submitting organizationjava.util.Collection<javax.xml.registry.infomodel.AuditableEvent> getEmbeddedAuditTrail() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the AuditTrail of all embedded objectsvoid 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
- if an internal error occursjava.util.Collection<javax.xml.registry.infomodel.RegistryObject> getRelationShipValue(CentraSiteRelationShipAttribute ra) throws javax.xml.registry.JAXRException
ra
- the CentraSiteRelationShipAttributejavax.xml.registry.JAXRException
- if an internal error occurs on retrieving the relationship attribute.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
- if an internal error occursvoid setFileValue(CentraSiteFileAttribute fa, java.util.Collection<java.lang.String> uris, boolean isOwningObject) 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.isOwningObject
- sets the file value if it is a owning objectjavax.xml.registry.JAXRException
- if an internal error occurs on updating the file valuejava.util.Collection<java.lang.String> getFileValue(CentraSiteFileAttribute fa) throws javax.xml.registry.JAXRException
fa
- the CentraSiteFileAttributejavax.xml.registry.JAXRException
- if an internal error occurs on retrieving the file valuevoid 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
- if an internal error occurs on setting the file with external linkvoid setFileWithExternalLink(CentraSiteFileAttribute fa, java.util.Collection<javax.xml.registry.infomodel.ExternalLink> externallinks, boolean isOwningObject) 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.isOwningObject
- sets the file value if it is a owning objectjavax.xml.registry.JAXRException
- if an internal error occurs on updating the file with external linkjava.util.Collection<javax.xml.registry.infomodel.ExternalLink> getFileAsExternalLink(CentraSiteFileAttribute fa) throws javax.xml.registry.JAXRException
fa
- the CentraSiteFileAttributejavax.xml.registry.JAXRException
- if an internal error occurs on retrieving the file as external linkvoid 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
- if an internal error occurs on updating the classification valuejava.util.Collection<java.lang.Object> getClassificationValue(CentraSiteClassificationAttribute ca) throws javax.xml.registry.JAXRException
ca
- the CentraSiteClassificationAttributejavax.xml.registry.JAXRException
- if an internal error occurs on retrieving the classification valuejavax.xml.registry.infomodel.Concept getVirtualObjectType() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs on retrieving the virtual object typevoid 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 statejavax.xml.registry.JAXRException
- if an internal error occursboolean isModifiedByUser() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs.boolean isModified() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs.boolean isLocked() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occursvoid removeExternalLinkId(java.lang.String externalLinkId) throws javax.xml.registry.JAXRException
externalLinkId
- the reference (id) of the external link to be removedjavax.xml.registry.JAXRException
- if an internal error occurs.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
- if an internal error occurs.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
- if an encounters an internal on adding POST listener.void setPropagatePermissions(boolean propagatePermissions) throws javax.xml.registry.JAXRException
propagatePermissions
- the boolean value to propagate permission.javax.xml.registry.JAXRException
- if an internal error occurs on permission propagation.boolean isPropagatePermissions() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occurs.void setPropagateProfilePermissions(boolean propagateProfilePermissions) throws javax.xml.registry.JAXRException
propagateProfilePermissions
- the boolean value to propagate profile permission.javax.xml.registry.JAXRException
- if an internal error occurs on enabling or disabling profile permission propagation.boolean isPropagateProfilePermissions() throws javax.xml.registry.JAXRException
javax.xml.registry.JAXRException
- if an internal error occursjavax.xml.registry.infomodel.AuditableEvent addCustomAuditableEvent() throws javax.xml.registry.JAXRException
AuditableEvent
objectjavax.xml.registry.JAXRException
- if internal error occurs on adding the custom auditable event