IFilterEnvironment (Oracle WebCenter Sites JavaDocs)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.openmarket.gator.interfaces
Interface IFilterEnvironment

public interface IFilterEnvironment

Interface which provides methods to obtain information about the filter's environment. These methods may be useful when implementing the IFilter class.

Method Summary
`java.lang.String`	`getAttributeIdentifier(java.lang.String attrName)` Returns Attribute ID given name.
`java.lang.String`	`getAttributeType()` Returns Attribute Type.
`java.lang.String`	`getFilterType()` Returns Filter Type
`java.lang.String`	`getGroupIdentifier(java.lang.String groupType, java.lang.String groupName)` Returns Flex Parent ID given name Flex Parent Type and Flex Parent Name.
`java.lang.String`	`getGroupTypeIdentifier(java.lang.String groupType, java.lang.String groupTypeName)` Returns Parent Definition ID given name Flex Parent Type and Flex Parent Definition Name.
`java.lang.String`	`getGroupTypeType(java.lang.String groupType)` Returns Flex Parent Definition Type given Flex Parent Type.
`ICS`	`getICS()` Returns handle to interface of Content Server object.

Method Detail

getICS

ICS getICS()

Returns handle to interface of Content Server object.

Returns:: ICS object

getAttributeIdentifier

java.lang.String getAttributeIdentifier(java.lang.String attrName)
                                        throws com.openmarket.basic.interfaces.AssetException

Returns Attribute ID given name.

Parameters:: attrName - attribute name
Returns:: string representation of attribute id
Throws:: com.openmarket.basic.interfaces.AssetException

getGroupIdentifier

java.lang.String getGroupIdentifier(java.lang.String groupType,
                                    java.lang.String groupName)
                                    throws com.openmarket.basic.interfaces.AssetException

Returns Flex Parent ID given name Flex Parent Type and Flex Parent Name.

Parameters:: groupType - assettype of parent; groupName - name of parent
Returns:: string representation of flex parent id
Throws:: com.openmarket.basic.interfaces.AssetException

getGroupTypeIdentifier

java.lang.String getGroupTypeIdentifier(java.lang.String groupType,
                                        java.lang.String groupTypeName)
                                        throws com.openmarket.basic.interfaces.AssetException

Returns Parent Definition ID given name Flex Parent Type and Flex Parent Definition Name.

Parameters:: groupType - assettype of parent; groupTypeName - name of parent definition
Returns:: string representation of parent definition id
Throws:: com.openmarket.basic.interfaces.AssetException

getAttributeType

java.lang.String getAttributeType()
                                  throws com.openmarket.basic.interfaces.AssetException

Returns Attribute Type.

Returns:: string representation of attribute type
Throws:: com.openmarket.basic.interfaces.AssetException

getFilterType

java.lang.String getFilterType()
                               throws com.openmarket.basic.interfaces.AssetException

Returns Filter Type

Returns:: string representation of filter type
Throws:: com.openmarket.basic.interfaces.AssetException

getGroupTypeType

java.lang.String getGroupTypeType(java.lang.String groupType)
                                  throws com.openmarket.basic.interfaces.AssetException

Returns Flex Parent Definition Type given Flex Parent Type.

For example: Given Content_P, Returns Content_PD

Parameters:: groupType - assettype of parent
Returns:: string represetnation of flex parent definition type
Throws:: com.openmarket.basic.interfaces.AssetException