|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.ifs.beans.LibraryObjectDefinition | +--oracle.ifs.beans.PublicObjectDefinition
The PublicObjectDefinition class is the abstract superclass of all public object definition classes. It is used to aid in the construction of PublicObjects by providing methods to set special properties common to all PublicObjects, such as Category, initial folder and securing public object.
Constructor Summary | |
PublicObjectDefinition(LibrarySession session)
Constructs a PublicObjectDefinition explicitly capturing the session. |
Method Summary | |
void |
addCategoryDefinition(CategoryDefinition def)
Adds a new Category Definition to the new PublicObject. |
AttributeValue |
getAddToFolderOption()
returns the Add To Folder Option for the new PublicObject. |
CategoryDefinition[] |
getCategoryDefinitions()
returns all the CategoryDefinitions for this PO Definition Return null if no Category definitions exist |
java.util.Date |
getExplicitCreateDate()
returns any explicitly specified CreateDate, if specified via the setExplicitCreateDateOption() method. |
java.util.Date |
getExplicitLastModifyDate()
returns any explicitly specified LastModifydate, if specified via the setExplicitLastModifyDate() method. |
boolean |
getFreeIfLastFolderReferenceOption()
return true if the FreeIfLastFolderReferenceOption has been set. |
boolean |
getKeepLastModifyDateOption()
return the indication as to whether the last modification date should remain unchanged as part of an update operation. |
boolean |
getLockForSessionOption()
return the indication as to whether the Lock For Session option is set. |
PublicObject |
getSecuringPublicObject()
returns the object responsible for providing security settings for the target object. |
boolean |
getUnlockForSessionOption()
return the indication as to whether the Unlock For Session option is set. |
void |
setAddToFolderOption(Folder folder)
set the Add To Folder Option for the new PublicObject. |
void |
setExplicitCreateDate(java.util.Date createDate)
sets an explicit CreateDate. |
void |
setExplicitLastModifyDate(java.util.Date modDate)
sets an explicit LastModifydate. |
void |
setFreeIfLastFolderReferenceOption(boolean option)
set or clear the option to free an object if it has no Folder references after it is explicitly removed fromt he last Folder. |
void |
setKeepLastModifyDateOption(boolean option)
set or clear the indication to keep the last modification unchanged as part of an update operation. |
void |
setLockForSessionOption(boolean option)
set or clear the option to obtain a Session lock. |
void |
setSecuringPublicObject(PublicObject obj)
set the object responsible for providing security settings for the target object. |
void |
setUnlockForSessionOption(boolean option)
set or clear the option to release a Session lock. |
Methods inherited from class oracle.ifs.beans.LibraryObjectDefinition |
clone, getAttribute, getAttributes, getClassObject, getOption, getOptionKeys, removeAttribute, removeOption, setAttribute, setAttribute, setAttributeByUpperCaseName, setAttributes, setClassObject, setOption |
Constructor Detail |
public PublicObjectDefinition(LibrarySession session) throws IfsException
session
- the current LibrarySessionIfsException
- if the operation failsMethod Detail |
public void addCategoryDefinition(CategoryDefinition def) throws IfsException
def
- the Category definition for the new Category.public CategoryDefinition[] getCategoryDefinitions() throws IfsException
IfsException
- if the operation failspublic void setKeepLastModifyDateOption(boolean option) throws IfsException
option
- true if the LastModifydate is to remain unchanged
after the update is applied.IfsException
- if operation fails.public boolean getKeepLastModifyDateOption() throws IfsException
IfsException
- if operation fails.public void setExplicitCreateDate(java.util.Date createDate) throws IfsException
the
- Create Date.IfsException
- if operation fails.public java.util.Date getExplicitCreateDate() throws IfsException
IfsException
- if operation fails.public void setExplicitLastModifyDate(java.util.Date modDate) throws IfsException
the
- Last Modification Date.IfsException
- if operation fails.public java.util.Date getExplicitLastModifyDate() throws IfsException
IfsException
- if operation fails.public void setLockForSessionOption(boolean option) throws IfsException
option
- true if the Lock For Session option
is in effect; specify false to clear this setting.IfsException
- if operation fails.public boolean getLockForSessionOption() throws IfsException
IfsException
- if operation fails.public void setFreeIfLastFolderReferenceOption(boolean option) throws IfsException
option
- true if the option is selected.IfsException
- if operation fails.public boolean getFreeIfLastFolderReferenceOption() throws IfsException
IfsException
- if operation fails.public void setUnlockForSessionOption(boolean option) throws IfsException
option
- true if the Unlock For Session option
is in effect; specify false to clear this setting.IfsException
- if operation fails.public boolean getUnlockForSessionOption() throws IfsException
IfsException
- if operation fails.public void setSecuringPublicObject(PublicObject obj) throws IfsException
obj
- the object responsible for providing security
settings for the target object.IfsException
- if operation fails.public PublicObject getSecuringPublicObject() throws IfsException
IfsException
- if operation fails.public void setAddToFolderOption(Folder folder) throws IfsException
folder
- the Folder in which to add the new object.IfsException
- if operation fails.public AttributeValue getAddToFolderOption() throws IfsException
IfsException
- if operation fails.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |