oracle.ifs.beans
Class SelectorObject

java.lang.Object
  |
  +--oracle.ifs.beans.LibraryObject
        |
        +--oracle.ifs.beans.TieLibraryObject
              |
              +--oracle.ifs.beans.PublicObject
                    |
                    +--oracle.ifs.beans.TiePublicObject
                          |
                          +--oracle.ifs.beans.SelectorObject

All Implemented Interfaces:

IfsEventHandler, LibraryObjectInterface, PublicObjectInterface, Traceable

Direct Known Subclasses:

TieSelectorObject

public class SelectorObject

extends TiePublicObject

The SelectorObject class is used to store Selectors in the server for later use. Create a SelectorObject by using a SelectorObjectDefinition and then calling LibrarySession.createSelectorObject().

From an instance of a SelectorObject, you can materialize a Selector to be used for simple searches.

See Also:

Selector, SelectorObjectDefinition

Field Summary

static java.lang.String	CLASS_NAME This class name for this class.
static java.lang.String	SELECTCLASSNAME_ATTRIBUTE The name of the iFS class from which objects are to be selected.
static java.lang.String	SELECTQUALIFICATION_ATTRIBUTE The criterion for the selection of objects in the iFS class.

Fields inherited from class oracle.ifs.beans.PublicObject

ACL_ATTRIBUTE, ADMINISTRATIONGROUP_ATTRIBUTE, CREATEDATE_ATTRIBUTE, CREATOR_ATTRIBUTE, DELETOR_ATTRIBUTE, DESCRIPTION_ATTRIBUTE, EXPIRATIONDATE_ATTRIBUTE, FAMILY_ATTRIBUTE, FLAGS_ATTRIBUTE, LASTMODIFIER_ATTRIBUTE, LASTMODIFYDATE_ATTRIBUTE, LOCKEDFORSESSION_ATTRIBUTE, LOCKOBJECT_ATTRIBUTE, LOCKSTATE_ATTRIBUTE, LOCKSTATE_HARDLOCK, LOCKSTATE_SESSIONLOCK, LOCKSTATE_SOFTLOCK, LOCKSTATE_UNLOCK, LOCKSTATE_USERLOCK, NAME_ATTRIBUTE, OWNER_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE, RESOLVEDPUBLICOBJECT_ATTRIBUTE, SECURINGPUBLICOBJECT_ATTRIBUTE

Method Summary

java.lang.String	getSelectClassname() Returns the selector class.
Selector	getSelector() Materialize a Selector instance that can be used to perform the selector operations.
java.lang.String	getSelectQualification() Returns the selector Qualification.
void	setSelectClassname(java.lang.String className) Sets the persistent select class.
void	setSelectCriteria(java.lang.String className, java.lang.String qual) Sets the both the persistent select class and qualification.
void	setSelectQualification(java.lang.String qual) Sets the persistent selector Qualification.

Methods inherited from class oracle.ifs.beans.PublicObject

addCategory, addRelationship, checkEffectiveAccess, checkEffectiveAccess, copy, getAcl, getAllFolderPaths, getAllFolderPaths, getAnyFolderPath, getAnyFolderPath, getCategories, getCategories, getCategories, getCategories, getCreateDate, getCreator, getDefaultAccessLevel, getDescription, getEffectiveAccessLevel, getEffectiveAccessLevel, getExpirationDate, getFamily, getFlags, getFolderReferences, getFolderReferencesSortSpecification, getLastModifier, getLastModifyDate, getLeftwardRelationshipObjects, getLeftwardRelationshipObjects, getLeftwardRelationships, getLeftwardRelationships, getLockObject, getLockState, getLockStateLabel, getOwner, getPolicyBundle, getPropertyBundle, getResolvedPublicObject, getRightwardRelationshipObjects, getRightwardRelationshipObjects, getRightwardRelationships, getRightwardRelationships, getSecuringPublicObject, grantAccess, handleEvent, hasNameAttribute, isLocked, isLockedForSession, isLockedForSessionByCurrentSession, isVersionable, isVersioned, lock, lock, lock, putPolicy, putProperty, putProperty, removeAllPolicies, removeAllProperties, removePolicy, removePolicy, removeProperty, removeRelationship, revokeAccess, revokeAllAccess, setAcl, setDescription, setExpirationDate, setFlags, setFolderReferencesSortSpecification, setOwner, setPolicyBundle, setPropertyBundle, setSecuringPublicObject, toLockStateLabel, toLockStateLabel, toLockStateLabel, unlock, updateLock

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

CLASS_NAME

public static final java.lang.String CLASS_NAME

This class name for this class. Useful for methods that take a class name argument.

SELECTCLASSNAME_ATTRIBUTE

public static final java.lang.String SELECTCLASSNAME_ATTRIBUTE

The name of the iFS class from which objects are to be selected.

SELECTQUALIFICATION_ATTRIBUTE

public static final java.lang.String SELECTQUALIFICATION_ATTRIBUTE

The criterion for the selection of objects in the iFS class.

Method Detail

getSelector

public Selector getSelector()
                     throws IfsException

Materialize a Selector instance that can be used to perform the selector operations.

Returns:

the Selector instance.

Throws:

IfsException - if operation fails.

getSelectClassname

public java.lang.String getSelectClassname()
                                    throws IfsException

Returns the selector class.

Returns:

the selector class.

Throws:

IfsException - if operation fails.

getSelectQualification

public java.lang.String getSelectQualification()
                                        throws IfsException

Returns the selector Qualification.

Returns:

the selector Qualification

Throws:

IfsException - if operation fails.

setSelectQualification

public void setSelectQualification(java.lang.String qual)
                            throws IfsException

Sets the persistent selector Qualification.

Parameters:

qual - the select Qualification.

Throws:

IfsException - if operation fails.

setSelectClassname

public void setSelectClassname(java.lang.String className)
                        throws IfsException

Sets the persistent select class.

Parameters:

className - a string representing the search class.

Throws:

IfsException - if operation fails.

setSelectCriteria

public void setSelectCriteria(java.lang.String className,
                              java.lang.String qual)
                       throws IfsException

Sets the both the persistent select class and qualification. This method is useful when both SelectorObject components (class and qualification) need to be updated together.

Parameters:

className - a string representing the select class.

qual - the select Qualification.

Throws:

IfsException - if operation fails.