|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.ifs.beans.LibraryObject | +--oracle.ifs.beans.TieLibraryObject | +--oracle.ifs.beans.PublicObject
The PublicObject class is the abstract superclass of all "public object" classes, some of which are Documents, Folders, and ApplicationObjects. The common traits of public objects are:
isVersionable()
method will tell you if that class can be
versioned.
Family
,
Relationship
,
Category
,
PublicObjectDefinition
Field Summary | |
static java.lang.String |
ACL_ATTRIBUTE
The AccessControlList that secures this object. |
static java.lang.String |
ADMINISTRATIONGROUP_ATTRIBUTE
The AdministrationGroup to which this object belongs. |
static java.lang.String |
CLASS_NAME
This class name for this class. |
static java.lang.String |
CREATEDATE_ATTRIBUTE
The date and time (in GMT) when this object was created. |
static java.lang.String |
CREATOR_ATTRIBUTE
The DirectoryUser that created this object. |
static java.lang.String |
DELETOR_ATTRIBUTE
The DirectoryUser that deleted (not 'Freed') this object. |
static java.lang.String |
DESCRIPTION_ATTRIBUTE
A textual description of this object. |
static java.lang.String |
EXPIRATIONDATE_ATTRIBUTE
The date when this object 'expires'. |
static java.lang.String |
FAMILY_ATTRIBUTE
The Family to which this object belongs if this object is versioned. |
static java.lang.String |
FLAGS_ATTRIBUTE
System-set flags of this object. |
static java.lang.String |
LASTMODIFIER_ATTRIBUTE
The DirectoryUser that last modified this object. |
static java.lang.String |
LASTMODIFYDATE_ATTRIBUTE
The date and time (in GMT) when this object was last modified. |
static java.lang.String |
LOCKEDFORSESSION_ATTRIBUTE
The lock set on this object for the duration of the current session. |
static java.lang.String |
LOCKSTATE_ATTRIBUTE
The type of lock on this object. |
static int |
LOCKSTATE_HARDLOCK
Represents hardlock state. |
static int |
LOCKSTATE_SESSIONLOCK
Represents sessionlock state. |
static int |
LOCKSTATE_SOFTLOCK
Represents softlock state. |
static int |
LOCKSTATE_UNLOCK
Represents unlock state. |
static int |
LOCKSTATE_USERLOCK
Represents userlock state. |
static java.lang.String |
NAME_ATTRIBUTE
The name of this object. |
static java.lang.String |
OWNER_ATTRIBUTE
The DirectoryUser that owns this object. |
static java.lang.String |
POLICYBUNDLE_ATTRIBUTE
The policies that apply specifically to this object. |
static java.lang.String |
PROPERTYBUNDLE_ATTRIBUTE
The PropertyBundle associated with this object. |
static java.lang.String |
RESOLVEDPUBLICOBJECT_ATTRIBUTE
The PublicObject to which this object resolves. |
static java.lang.String |
SECURINGPUBLICOBJECT_ATTRIBUTE
A PublicObject from which this object should defer security decisions (e.g, all versions in a Family may have the Family as their securing public object). |
Method Summary | |
void |
addCategory(CategoryDefinition catdef)
Adds a Category associated with this PublicObject. |
Relationship |
addRelationship(RelationshipDefinition reldef)
Creates a relationship object linking this object (the "left" object) to the PublicObject (the "right" object) contained in the specified Relationship Definition. |
boolean |
checkEffectiveAccess(AccessLevel level)
Check to see if current user has the specified access level on this object. |
boolean |
checkEffectiveAccess(DirectoryObject obj,
AccessLevel level)
Check to see if specified user has the specified access level on this object. |
PublicObject |
copy(LibraryObjectDefinition def)
Produces a copy of this PublicObject. |
AccessControlList |
getAcl()
Returns this object's AccessControlList. |
java.lang.String[] |
getAllFolderPaths()
Gets all Folder paths to the target object, starting from the Root Folder. |
java.lang.String[] |
getAllFolderPaths(Folder reference)
get all Folder paths to the target object. |
java.lang.String |
getAnyFolderPath()
Gets any Folder path to the target object, starting from the Root Folder. |
java.lang.String |
getAnyFolderPath(Folder reference)
Gets any Folder path to the target object. |
Category[] |
getCategories()
Returns the associated Category objects. |
Category[] |
getCategories(SortSpecification sort)
Returns the associated Category objects. |
java.util.Date |
getCreateDate()
Returns the date this object was created. |
DirectoryUser |
getCreator()
returns the user that created this object. |
AccessLevel |
getDefaultAccessLevel()
Returns the access level defined for "World" access; i.e. |
java.lang.String |
getDescription()
Returns the description of this object |
AccessLevel |
getEffectiveAccessLevel()
Get the access level on this object for the current user. |
AccessLevel |
getEffectiveAccessLevel(DirectoryObject obj)
Get the access level on this object for the specified user. |
java.util.Date |
getExpirationDate()
Returns the expiration date set for this object |
Family |
getFamily()
Returns the Family with which this object is associated. |
int |
getFlags()
Gets the flags bitmask. |
SortSpecification |
getFolderReferencesSortSpecification()
Returns the current sort specification used by the getFolderReferences method. |
DirectoryUser |
getLastModifier()
Returns the user that last modified this object. |
java.util.Date |
getLastModifyDate()
Returns the date this object was last modified |
PublicObject[] |
getLeftwardRelationshipObjects(ClassObject relClass)
Returns all "left side" public objects that are related to this object by the specied Relationship Class. |
PublicObject[] |
getLeftwardRelationshipObjects(java.lang.String relClassName)
Returns all "left side" public objects that are related to this object by the specied Relationship Class. |
Relationship[] |
getLeftwardRelationships(ClassObject relClass)
Returns all "left side" relationship instances that are used to relate to this object to other PublicObjects. |
Relationship[] |
getLeftwardRelationships(java.lang.String relClassName)
Returns all "left side" relationship instances that are used to relate to this object to other PublicObjects. |
int |
getLockedState()
Deprecated. use getLockState() |
int |
getLockState()
Returns the lock state of this object |
java.lang.String |
getLockStateLabel()
Gets the localized String label for the LockState set for this instance. |
DirectoryUser |
getOwner()
Returns the user that owns the object. |
PolicyPropertyBundle |
getPolicyBundle()
Returns this object's PolicyPropertyBundle. |
PropertyBundle |
getPropertyBundle()
Returns this object's PropertyBundle. |
PublicObject |
getResolvedPublicObject()
Returns the PublicObject to which this object resolves. |
PublicObject[] |
getRightwardRelationshipObjects(ClassObject relClass)
Returns all "right side" public objects that are related to this object by the specified Relationship Class. |
PublicObject[] |
getRightwardRelationshipObjects(java.lang.String relClassName)
Returns all "right side" public objects that are related to this object by the specified Relationship Class. |
Relationship[] |
getRightwardRelationships(ClassObject relClass)
Returns all "right side" relationship instances that are used to relate to this object to other PublicObjects. |
Relationship[] |
getRightwardRelationships(java.lang.String relClassName)
Returns all "right side" relationship instances that are used to relate to this object to other PublicObjects. |
PublicObject |
getSecuringPublicObject()
Returns the Public Object that controls this object's security. |
AccessControlEntry |
grantAccess(AccessControlEntryDefinition def)
Add or extend an AccessControlEntryDefinition for this object. |
void |
handleEvent(IfsEvent event)
Handles the specified event. |
protected boolean |
hasNameAttribute()
Override to return true for any PublicObject, indicating that the instance has a NAME attribute. |
boolean |
isLocked()
Returns true when lock state is not unlock. |
boolean |
isLockedForSession()
Returns true if there is a session lock held on this object. |
boolean |
isLockedForSessionByCurrentSession()
Returns true if there is a session lock held on this object, and it is held by the invoking session. |
boolean |
isVersionable()
Returns true if this class of object is versionable. |
boolean |
isVersioned()
returns true if this object is versioned (FAMILY != null) |
void |
lock(int lockValue)
Obtain a lock on the object. |
void |
putPolicy(Policy policy)
Adds a Policy to this object's PolicyPropertyBundle. |
void |
putProperty(AttributeValue av)
Adds a Property to this object's PropertyBundle. |
void |
putProperty(java.lang.String name,
AttributeValue av)
Adds a Property to this object's PropertyBundle. |
void |
removeAllPolicies()
Removes all Policies from this object's PolicyPropertyBundle, leaving an empty PolicyPropertyBundle. |
void |
removeAllProperties()
Removes all Properties from this object's PropertyBundle, leaving an empty PropertyBundle. |
void |
removePolicy(Policy policy)
Removes a Policy from this object's PolicyPropertyBundle. |
void |
removePolicy(java.lang.String opname)
Removes a Policy from this object's PolicyPropertyBundle. |
void |
removeProperty(java.lang.String name)
Removes a Property from this object's PropertyBundle. |
void |
removeRelationship(Relationship rel)
Frees the specified relationship object that relates two PublicObjects. |
AccessControlEntry |
revokeAccess(AccessControlEntryDefinition def)
Remove or restrict an AccessControlEntryDefinition for this object. |
void |
revokeAllAccess()
Remove all AccessControlEntryDefinitions for this object. |
void |
setAcl(AccessControlList acl)
Sets the AccessControlList for this object. |
void |
setDescription(java.lang.String description)
Updates the description of this object. |
void |
setExpirationDate(java.util.Date date)
Updates the expiration date set for this object. |
void |
setFlags(int flags)
Sets the flags bitmask. |
void |
setFolderReferencesSortSpecification(SortSpecification spec)
Sets the sort specification used by the getFolderReferences method. |
void |
setOwner(DirectoryUser owner)
Updates the owner of this object. |
void |
setPolicyBundle(PolicyPropertyBundle bundle)
set the PolicyPropertyBundle for this object, for the managing of per-instance Policies. |
void |
setPropertyBundle(PropertyBundle bundle)
Sets this object's PropertyBundle. |
void |
setSecuringPublicObject(PublicObject pubobj)
Sets the Public Object that controls our security. |
static java.lang.String |
toLockStateLabel(int lockState)
Converts the specified LockState constant to a localized label. |
static java.lang.String |
toLockStateLabel(int lockState,
LibrarySession session)
Converts the specified LockState constant to a localized label, using the Localizer from the specified LibrarySession. |
static java.lang.String |
toLockStateLabel(int lockState,
Localizer localizer)
Converts the specified LockState constant to a localized label, using the specified Localizer. |
void |
unlock()
Releases the persistent lock on the object. |
Methods inherited from class oracle.ifs.beans.LibraryObject |
equals, free, free, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getClassId, getClassObject, getDefinition, getId, getLabel, getName, getSession, invokeServerMethod, isInstanceOf, isTraced, lookupInstanceLabel, postEvent, postEvent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setName, toString, trace, update |
Methods inherited from interface oracle.ifs.common.LibraryObjectInterface |
getId |
Methods inherited from interface oracle.ifs.common.Traceable |
getTraceLogger, isTraced, trace |
Field Detail |
public static final java.lang.String CLASS_NAME
public static final java.lang.String NAME_ATTRIBUTE
public static final java.lang.String DESCRIPTION_ATTRIBUTE
public static final java.lang.String OWNER_ATTRIBUTE
public static final java.lang.String ACL_ATTRIBUTE
public static final java.lang.String FAMILY_ATTRIBUTE
public static final java.lang.String RESOLVEDPUBLICOBJECT_ATTRIBUTE
public static final java.lang.String CREATEDATE_ATTRIBUTE
public static final java.lang.String CREATOR_ATTRIBUTE
public static final java.lang.String LASTMODIFYDATE_ATTRIBUTE
public static final java.lang.String LASTMODIFIER_ATTRIBUTE
public static final java.lang.String DELETOR_ATTRIBUTE
public static final java.lang.String POLICYBUNDLE_ATTRIBUTE
public static final java.lang.String PROPERTYBUNDLE_ATTRIBUTE
public static final java.lang.String ADMINISTRATIONGROUP_ATTRIBUTE
public static final java.lang.String SECURINGPUBLICOBJECT_ATTRIBUTE
public static final java.lang.String EXPIRATIONDATE_ATTRIBUTE
public static final java.lang.String LOCKSTATE_ATTRIBUTE
public static final java.lang.String FLAGS_ATTRIBUTE
public static final java.lang.String LOCKEDFORSESSION_ATTRIBUTE
public static final int LOCKSTATE_UNLOCK
public static final int LOCKSTATE_HARDLOCK
public static final int LOCKSTATE_SOFTLOCK
public static final int LOCKSTATE_USERLOCK
public static final int LOCKSTATE_SESSIONLOCK
Method Detail |
protected boolean hasNameAttribute() throws IfsException
hasNameAttribute
in class LibraryObject
IfsException
- if operation fails.public java.util.Date getCreateDate() throws IfsException
IfsException
- if operation fails.public DirectoryUser getCreator() throws IfsException
IfsException
- if operation fails.public DirectoryUser getLastModifier() throws IfsException
IfsException
- if operation fails.public java.lang.String getDescription() throws IfsException
IfsException
- if operation fails.public void setDescription(java.lang.String description) throws IfsException
description
- New descriptionIfsException
- if operation fails.public java.util.Date getLastModifyDate() throws IfsException
IfsException
- if operation fails.public DirectoryUser getOwner() throws IfsException
IfsException
- if operation fails.public void setOwner(DirectoryUser owner) throws IfsException
owner
- the new owner for the object.IfsException
- if operation fails.public void setAcl(AccessControlList acl) throws IfsException
acl
- - the AccessControlList setting.IfsException
- if operation fails.AccessControlList
public AccessControlList getAcl() throws IfsException
IfsException
- if operation fails.public PublicObject getSecuringPublicObject() throws IfsException
IfsException
- if operation fails.public void setSecuringPublicObject(PublicObject pubobj) throws IfsException
publicobject
- the PublicObject that controls the securityIfsException
- if operation fails.public void addCategory(CategoryDefinition catdef) throws IfsException
catdef
- the CategoryDefinition that describes the new Category
that will be associated with this PublicObject.IfsException
- if operation fails.public Category[] getCategories() throws IfsException
IfsException
- if operation fails.public Category[] getCategories(SortSpecification sort) throws IfsException
sort
- the specification of how the returned Category
objects will be sorted.IfsException
- if operation fails.public java.util.Date getExpirationDate() throws IfsException
IfsException
- if operation fails.public void setExpirationDate(java.util.Date date) throws IfsException
date
- New expiration dateIfsException
- if operation fails.public int getFlags() throws IfsException
IfsException
- if the operation failspublic void setFlags(int flags) throws IfsException
Equivalent to:
AttributeValue av = AttributeValue.newAttributeValue(flags);
setAttribute(FLAGS_ATTRIBUTE, av);
flags
- the flags value.IfsException
- if the operation failspublic int getLockedState() throws IfsException
IfsException
- if operation fails.public int getLockState() throws IfsException
IfsException
- if operation fails.public java.lang.String getLockStateLabel() throws IfsException
IfsException
- if operation fails.public static java.lang.String toLockStateLabel(int lockState) throws IfsException
lockState
- the LockState constant.IfsException
- if operation fails.public static java.lang.String toLockStateLabel(int lockState, LibrarySession session) throws IfsException
lockState
- the LockState constantsession
- the LibrarySession, whose current
Localizer will be used for the conversionIfsException
- if operation fails.public static java.lang.String toLockStateLabel(int lockState, Localizer localizer) throws IfsException
lockState
- the LockState constant.localizer
- the Localizer that performs the conversionIfsException
- if operation fails.public boolean isLocked() throws IfsException
IfsException
- if operation fails.public boolean isLockedForSession() throws IfsException
IfsException
- if operation fails.public boolean isLockedForSessionByCurrentSession() throws IfsException
IfsException
- if operation fails.public void lock(int lockValue) throws IfsException
IfsException
- if operation fails.public void unlock() throws IfsException
IfsException
- if operation fails.public void setPropertyBundle(PropertyBundle bundle) throws IfsException
bundle
- the Properties setting.IfsException
- if operation fails.public PropertyBundle getPropertyBundle() throws IfsException
IfsException
- if operation fails.public void putProperty(AttributeValue av) throws IfsException
av
- the name/value of the property to addIfsException
- if operation fails.public void putProperty(java.lang.String name, AttributeValue av) throws IfsException
name
- the name of the new propertyvalue
- the value of the new propertyIfsException
- if operation fails.public void removeProperty(java.lang.String name) throws IfsException
name
- the name of the property to removeIfsException
- if operation fails.public void removeAllProperties() throws IfsException
IfsException
- if operation fails.public void putPolicy(Policy policy) throws IfsException
policy
- the Policy to addIfsException
- if operation fails.public void removePolicy(java.lang.String opname) throws IfsException
av
- the operation name of the policy to removeIfsException
- if operation fails.public void removePolicy(Policy policy) throws IfsException
av
- the operation name of the policy to removeIfsException
- if operation fails.public void removeAllPolicies() throws IfsException
IfsException
- if operation fails.public void setPolicyBundle(PolicyPropertyBundle bundle) throws IfsException
bundle
- the PolicyPropertyBundle setting.IfsException
- if operation fails.public PolicyPropertyBundle getPolicyBundle() throws IfsException
IfsException
- if operation fails.public java.lang.String getAnyFolderPath() throws IfsException
IfsException
- if operation fails.getFolderReferences()
public java.lang.String getAnyFolderPath(Folder reference) throws IfsException
IfsException
- if operation fails.getFolderReferences()
public java.lang.String[] getAllFolderPaths() throws IfsException
IfsException
- if operation fails.getFolderReferences()
public java.lang.String[] getAllFolderPaths(Folder reference) throws IfsException
IfsException
- if operation fails.getFolderReferences()
public SortSpecification getFolderReferencesSortSpecification() throws IfsException
IfsException
- if operation fails.getFolderReferences()
public void setFolderReferencesSortSpecification(SortSpecification spec) throws IfsException
spec
- the folder references sort specification.IfsException
- if operation fails.getFolderReferences()
public PublicObject copy(LibraryObjectDefinition def) throws IfsException
def
- Definition describing changes to the new object, or null for exact copy.IfsException
- if operation fails.public Relationship addRelationship(RelationshipDefinition reldef) throws IfsException
relationshipDefinition.
- Describes the new Relationship object,
including the PublicObject to which this object will be related.IfsException
- if operation fails.public void removeRelationship(Relationship rel) throws IfsException
Relationship
- the relationship object to be removed.IfsException
- if operation fails.public PublicObject[] getRightwardRelationshipObjects(java.lang.String relClassName) throws IfsException
RelationshipClassName
- the name of the class of relationship on which to filter.IfsException
- if operation fails.public PublicObject[] getRightwardRelationshipObjects(ClassObject relClass) throws IfsException
RelationshipClass
- the class of relationship on which to filter.IfsException
- if operation fails.public PublicObject[] getLeftwardRelationshipObjects(java.lang.String relClassName) throws IfsException
RelationshipClassName
- the name of the class of relationship on which to filter.IfsException
- if operation fails.public PublicObject[] getLeftwardRelationshipObjects(ClassObject relClass) throws IfsException
RelationshipClass
- the class of relationship on which to filter.IfsException
- if operation fails.public Relationship[] getRightwardRelationships(java.lang.String relClassName) throws IfsException
RelationshipClassName
- the name of the class of relationship on which to filter.IfsException
- if operation fails.public Relationship[] getRightwardRelationships(ClassObject relClass) throws IfsException
RelationshipClass
- the class of relationship on which to filter.IfsException
- if operation fails.public Relationship[] getLeftwardRelationships(java.lang.String relClassName) throws IfsException
RelationshipClassName
- the name of the class of relationship on which to filter.IfsException
- if operation fails.public Relationship[] getLeftwardRelationships(ClassObject relClass) throws IfsException
RelationshipClass
- the class of relationship on which to filter.IfsException
- if operation fails.public boolean isVersioned() throws IfsException
IfsException
- if operation fails.Family
public Family getFamily() throws IfsException
IfsException
- if operation fails.public PublicObject getResolvedPublicObject() throws IfsException
this
. For the version classes, (Family,
VersionSeries, and VersionDescription), this will return a non
version-class object as determined by the configuration of the instance
of the version class.
For example, getResolvedPublicObject() on a VersionDescription will return the
PublicObject which it is tracking [same as
VersionDescription.getPublicObject()
].
For a VersionSeries, this will normally return the latest versioned PublicObject in that series (but this can be overridden). Refer to each version class' javadoc for details.
IfsException
- if operation fails.Family.setDefaultVersionDescription(oracle.ifs.beans.VersionDescription)
,
Family.setPrimaryVersionSeries(oracle.ifs.beans.VersionSeries)
,
VersionSeries.setDefaultVersionDescription(oracle.ifs.beans.VersionDescription)
public boolean isVersionable() throws IfsException
IfsException
- if operation fails.public void handleEvent(IfsEvent event) throws IfsException
handleEvent
in class LibraryObject
event
- the eventIfsException
- if the operation failspublic AccessLevel getDefaultAccessLevel() throws IfsException
IfsException
- if operation fails.public AccessLevel getEffectiveAccessLevel() throws IfsException
IfsException
- if operation fails.public AccessLevel getEffectiveAccessLevel(DirectoryObject obj) throws IfsException
user
- specified user on which to check Access ControlIfsException
- if operation fails.public boolean checkEffectiveAccess(AccessLevel level) throws IfsException
level
- specified level.IfsException
- if operation fails.public boolean checkEffectiveAccess(DirectoryObject obj, AccessLevel level) throws IfsException
user
- specified user on which to check Access Controllevel
- specified level.IfsException
- if operation fails.public AccessControlEntry grantAccess(AccessControlEntryDefinition def) throws IfsException
def
- AccessControlEntryDefinition definitionIfsException
- if operation fails.public AccessControlEntry revokeAccess(AccessControlEntryDefinition def) throws IfsException
def
- AccessControlEntryDefinition definitionIfsException
- if operation fails.public void revokeAllAccess() throws IfsException
IfsException
- if operation fails.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |