public interface CentraSiteRegistryObject extends CentraSiteExtensibleObject
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.
|
AuditableEvent |
addCustomAuditableEvent()
Creates and returns a auditable event with
event type being CUSTOM
owner would be the caller
applied object would be this registyobject.
|
AuditableEvent |
addImportUpdateAuditableEvent()
Creates and returns an auditable event signaling an update of the archive import.
|
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.util.Collection<RegistryObject> |
getConsumers()
Gets the registered consumers of the object.
|
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<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<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.
|
User |
getOwner()
Gets this object's owner.
|
CentraSiteRegistryObject |
getParentObject()
Return the parent of this object
|
User |
getPreviousOwner()
Gets this object's previous owner.
|
Organization |
getPreviousSubmittingOrganization()
Gets current object's previous submitting organization.
|
java.util.Collection<RegistryObject> |
getRelationShipValue(CentraSiteRelationShipAttribute ra)
Gets the value for the given RelationShip attribute.
|
java.util.Map<RegistryObject,java.util.Collection<Slot>> |
getRelationShipValueMap(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.
|
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(Concept previousState,
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<ExternalLink> externallinks)
Sets the value for the given File attribute.
|
void |
setFileWithExternalLink(CentraSiteFileAttribute fa,
java.util.Collection<ExternalLink> externallinks,
boolean isOwningObject)
Sets the value for the given File attribute.
|
void |
setIgnoreForImport()
Indicate that object should not be collected during archive-import
|
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(User owner)
Sets this object's owner.
|
void |
setParentObject(CentraSiteRegistryObject parent)
Set the parent for this object
|
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<RegistryObject> targets)
Sets the value for the given RelationShip attribute.
|
void |
setRelationShipValueMap(CentraSiteRelationShipAttribute ra,
java.util.Map<RegistryObject,java.util.Collection<Slot>> targetInfoMap)
Sets the value for the given RelationShip attribute.
|
void |
setSubmittingOrganization(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
void addAuditComment(java.lang.String comment) throws JAXRException
comment
- the comment to be added. Ignored if null.JAXRException
- if an internal error occurs on adding the audit commentboolean isAclModified()
boolean isPermissionModified() throws JAXRException
JAXRException
- if an internal error occurs on modifying the object's permissionboolean isDescendantObjectModified()
boolean isObjectModified()
boolean isMoveOwner() throws JAXRException
JAXRException
- if an internal error occurs on moving to a new owner.boolean isMoveOrganization() throws JAXRException
JAXRException
- if an internal error occurs on moving to a new organization.boolean isMoved() throws JAXRException
JAXRException
- if an internal error occurs on moving to a new organization or to a new owner.boolean isPredefined() throws JAXRException
JAXRException
- if an internal error occursboolean isDeleted()
boolean isRevisionObject()
CentraSiteRegistryObject getEnclosingObject() throws JAXRException
JAXRException
- if an internal error occurs on retrieving the enclosing object.User getOwner() throws JAXRException
JAXRException
- if an internal error occurs on retrieving the object's owner.User getPreviousOwner() throws JAXRException
JAXRException
- if an internal error occurs on retrieving the object's previous owner.CentraSiteACL getCentraSiteACL() throws JAXRException
JAXRException
- if an internal error occurs on retrieving the CentraSiteACL object.void setCentraSiteACL(CentraSiteACL acl) throws JAXRException
acl
- the CentraSiteACLJAXRException
- if an internal error occurs on setting the CentraSiteACL object.InstanceLevelPermissionSet getInstanceLevelPermissionSet() throws JAXRException
JAXRException
- if an internal error occurs on retrieving the InstanceLevelPermissionSet.void setInstanceLevelPermissionSet(InstanceLevelPermissionSet permissionSet) throws JAXRException
permissionSet
- the InstanceLevelPermissionSet for this RegistryObjectJAXRException
- if an internal error occurs on setting the InstanceLevelPermissionSet.InstanceLevelPrivilege getCurrentUserPrivilege() throws JAXRException
JAXRException
- if an internal error occurs on retrieving the Privilege of the current user.void setLocked(boolean locked) throws JAXRException
locked
- true if object is lockedJAXRException
- if an internal error occursvoid setOwner(User owner) throws JAXRException
owner
- this object's ownerJAXRException
- if an internal error occursjava.lang.String toXMLforExport() throws JAXRException
JAXRException
- if an internal error occurs.java.lang.String toXMLforExport(java.util.Collection<java.lang.Integer> exportQualifiers) throws JAXRException
exportQualifiers
- a collection of ExportQualifiers. Must not be null.JAXRException
- if an internal error occursvoid accept(CentraSiteRegistryObjectVisitor visitor) throws JAXRException
visitor
- a CentraSiteRegistryObjectVisitorJAXRException
- if an internal error occursboolean isInternal() throws JAXRException
JAXRException
- if an internal error occursvoid setInternal(boolean internal) throws JAXRException
internal
- true if this RegistryObject is to be marked as internal, false otherwiseJAXRException
- if an internal error occursboolean isClassifiedWith(java.lang.String conceptId) throws JAXRException
conceptId
- the concept id to be checkedJAXRException
- if an internal error occursboolean isAssociatedTo(java.lang.String targetObjectId, java.lang.String associationTypeId) throws JAXRException
targetObjectId
- the target object ID.associationTypeId
- the associated type ID to check against.JAXRException
- if an internal error occursjava.sql.Timestamp getCreationDate() throws JAXRException
JAXRException
- if an internal error occurs on retrieving the creation datejava.sql.Timestamp getLastModificationDate() throws JAXRException
JAXRException
- if an internal error occurs on retrieving the last-modification datelong getServerTimezoneOffset() throws JAXRException
JAXRException
- if an internal error occursvoid setSubmittingOrganization(Organization organization) throws JAXRException
organization
- the Organization
object.JAXRException
- if a registry error occursjava.lang.String getSubmittingOrganizationKey()
Organization getPreviousSubmittingOrganization() throws JAXRException
JAXRException
- if an internal error occurs on retrieving the previous submitting organizationjava.util.Collection<AuditableEvent> getEmbeddedAuditTrail() throws JAXRException
JAXRException
- if an internal error occurs on retrieving the AuditTrail of all embedded objectsvoid setRelationShipValue(CentraSiteRelationShipAttribute ra, java.util.Collection<RegistryObject> targets) throws 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.JAXRException
- if an internal error occursvoid setRelationShipValueMap(CentraSiteRelationShipAttribute ra, java.util.Map<RegistryObject,java.util.Collection<Slot>> targetInfoMap) throws JAXRException
ra
- targetInfoMap
- JAXRException
java.util.Collection<RegistryObject> getRelationShipValue(CentraSiteRelationShipAttribute ra) throws JAXRException
ra
- the CentraSiteRelationShipAttributeJAXRException
- if an internal error occurs on retrieving the relationship attribute.java.util.Map<RegistryObject,java.util.Collection<Slot>> getRelationShipValueMap(CentraSiteRelationShipAttribute ra) throws JAXRException
ra
- the CentraSiteRelationShipAttributeJAXRException
- if an internal error occurs on retrieving the relationship attribute.void setFileValue(CentraSiteFileAttribute fa, java.util.Collection<java.lang.String> uris) throws 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.JAXRException
- if an internal error occursvoid setFileValue(CentraSiteFileAttribute fa, java.util.Collection<java.lang.String> uris, boolean isOwningObject) throws 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 objectJAXRException
- if an internal error occurs on updating the file valuejava.util.Collection<java.lang.String> getFileValue(CentraSiteFileAttribute fa) throws JAXRException
fa
- the CentraSiteFileAttributeJAXRException
- if an internal error occurs on retrieving the file valuevoid setFileWithExternalLink(CentraSiteFileAttribute fa, java.util.Collection<ExternalLink> externallinks) throws 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.JAXRException
- if an internal error occurs on setting the file with external linkvoid setFileWithExternalLink(CentraSiteFileAttribute fa, java.util.Collection<ExternalLink> externallinks, boolean isOwningObject) throws 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 objectJAXRException
- if an internal error occurs on updating the file with external linkjava.util.Collection<ExternalLink> getFileAsExternalLink(CentraSiteFileAttribute fa) throws JAXRException
fa
- the CentraSiteFileAttributeJAXRException
- if an internal error occurs on retrieving the file as external linkvoid setClassificationValue(CentraSiteClassificationAttribute ca, java.util.Collection<java.lang.Object> values) throws 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.JAXRException
- if an internal error occurs on updating the classification valuejava.util.Collection<java.lang.Object> getClassificationValue(CentraSiteClassificationAttribute ca) throws JAXRException
ca
- the CentraSiteClassificationAttributeJAXRException
- if an internal error occurs on retrieving the classification valueConcept getVirtualObjectType() throws JAXRException
JAXRException
- if an internal error occurs on retrieving the virtual object typevoid logLCStateChange(Concept previousState, Concept nextState) throws JAXRException
previousState
- the previous state, null when setting the initial statenextState
- the next stateJAXRException
- if an internal error occursboolean isModifiedByUser() throws JAXRException
JAXRException
- if an internal error occurs.boolean isModified() throws JAXRException
JAXRException
- if an internal error occurs.boolean isLocked() throws JAXRException
JAXRException
- if an internal error occursvoid removeExternalLinkId(java.lang.String externalLinkId) throws JAXRException
externalLinkId
- the reference (id) of the external link to be removedJAXRException
- if an internal error occurs.void addPreListener(java.lang.String listenerName, CentraSiteRegistryObjectListener preListener) throws JAXRException
listenerName
- listener name used to associate/retrieve
CentraSiteRegistryObjectListener instance.preListener
- CentraSiteRegistryObjectListener instance encapsulate the
steps need to execute.JAXRException
- if an internal error occurs.void addPostListener(java.lang.String listenerName, CentraSiteRegistryObjectListener postListener) throws JAXRException
listenerName
- listener name used to associate/retrieve
CentraSiteRegistryObjectListener instance.postListener
- CentraSiteRegistryObjectListener instance encapsulate the
steps need to execute.JAXRException
- if an encounters an internal on adding POST listener.void setPropagatePermissions(boolean propagatePermissions) throws JAXRException
propagatePermissions
- the boolean value to propagate permission.JAXRException
- if an internal error occurs on permission propagation.boolean isPropagatePermissions() throws JAXRException
JAXRException
- if an internal error occurs.void setPropagateProfilePermissions(boolean propagateProfilePermissions) throws JAXRException
propagateProfilePermissions
- the boolean value to propagate profile permission.JAXRException
- if an internal error occurs on enabling or disabling profile permission propagation.boolean isPropagateProfilePermissions() throws JAXRException
JAXRException
- if an internal error occursAuditableEvent addCustomAuditableEvent() throws JAXRException
AuditableEvent
objectJAXRException
- if internal error occurs on adding the custom auditable eventjava.util.Collection<RegistryObject> getConsumers() throws JAXRException
Collection
of RegistryObject
as consumers.JAXRException
- if an internal error occursCentraSiteRegistryObject getParentObject() throws JAXRException
JAXRException
void setParentObject(CentraSiteRegistryObject parent) throws JAXRException
JAXRException
AuditableEvent addImportUpdateAuditableEvent() throws JAXRException
AuditableEvent
update objectJAXRException
void setIgnoreForImport()