com.webmethods.portal.bizPolicy.biz
Interface IBizPolicyManager


public interface IBizPolicyManager

IBizPolicyManager manages all the registered IBizPolicys. This includes lifetime events (installation, uninstallation) as well as access to the IBizPolicys.

The IBizPolicyManager extends IThingComponentProvider and therefore stores all of the metadata about which policies are available, registered, enabled, etc in the database as instances of com.webmethods.portal.service.meta2.storage.impl.ComponentData stored in a system folder.

In order to access an IBizPolicy use one of the IBizPolicyManager.getBizPolicy(java.lang.String) APIs.


Field Summary
static String ACCESS_POLICY
          Deprecated. use IBizPolicyNames.ACCESS instead.
static String ALIAS_POLICY
          Deprecated. use IBizPolicyNames.ALIAS instead.
static String BASIC_POLICY
          Deprecated. use IBizPolicyNames.BASIC instead.
static String DIRECTORY_POLICY
          Deprecated. use IBizPolicyNames#DIRECTORY instead.
static String FOLDER_POLICY
          Deprecated. use IBizPolicyNames.FOLDER instead.
static String INSTALL_POLICY
          Deprecated. use IBizPolicyNames.INSTALL instead.
static String META_POLICY
          Deprecated. use IBizPolicyNames.BASIC instead.
static String SYSTEM_POLICY
          Deprecated. use IBizPolicyNames.SYSTEM instead.
static String TOPIC_POLICY
          Deprecated. use IBizPolicyNames.TOPIC instead.
static String TOPICSPACE_POLICY
          Deprecated. use IBizPolicyNames#TOPIC_SPACE instead.
static String USER_POLICY
          Deprecated. use IBizPolicyNames#USER instead.
static String VERSIONABLE_POLICY
          Deprecated. use IBizPolicyNames.VERSIONABLE instead.
 
Method Summary
 IBizPolicy getBizPolicy(IURI uri)
          Returns an appropriate interface for the specified resource.
 IBizPolicy getBizPolicy(String bizPolicyName)
          Retrieve an IBizPolicy by name.
 

Field Detail

SYSTEM_POLICY

static final String SYSTEM_POLICY
Deprecated. use IBizPolicyNames.SYSTEM instead.
BizPolicy for system-wide generic operations.

See Also:
ISystemPolicy, Constant Field Values

META_POLICY

static final String META_POLICY
Deprecated. use IBizPolicyNames.BASIC instead.
BizPolicy for manipulation of basic portal objects (documents, links, topics, folders, etc).

See Also:
IBasicPolicy, Constant Field Values

ACCESS_POLICY

static final String ACCESS_POLICY
Deprecated. use IBizPolicyNames.ACCESS instead.
BizPolicy for controlling portal access controls.

See Also:
IAccessPolicy, Constant Field Values

ALIAS_POLICY

static final String ALIAS_POLICY
Deprecated. use IBizPolicyNames.ALIAS instead.
BizPolicy for managing portal aliases.

See Also:
IAliasPolicy, Constant Field Values

TOPICSPACE_POLICY

static final String TOPICSPACE_POLICY
Deprecated. use IBizPolicyNames#TOPIC_SPACE instead.
BizPolicy for managing aliases that link portal resources together.

See Also:
com.webmethods.portal.bizPolicy.biz.alias.ITopicSpacePolicy, Constant Field Values

BASIC_POLICY

static final String BASIC_POLICY
Deprecated. use IBizPolicyNames.BASIC instead.
BizPolicy for manipulation of basic portal objects (documents, links, topics, folders, etc).

See Also:
IBasicPolicy, Constant Field Values

FOLDER_POLICY

static final String FOLDER_POLICY
Deprecated. use IBizPolicyNames.FOLDER instead.
BizPolicy for manipulation of folders.

See Also:
IContainerPolicy, Constant Field Values

TOPIC_POLICY

static final String TOPIC_POLICY
Deprecated. use IBizPolicyNames.TOPIC instead.
BizPolicy for manipulation of topics.

See Also:
IContainerPolicy, Constant Field Values

VERSIONABLE_POLICY

static final String VERSIONABLE_POLICY
Deprecated. use IBizPolicyNames.VERSIONABLE instead.
BizPolicy for accessing version control system.

See Also:
IVersionPolicy, Constant Field Values

DIRECTORY_POLICY

static final String DIRECTORY_POLICY
Deprecated. use IBizPolicyNames#DIRECTORY instead.
BizPolicy for directory services.

See Also:
com.webmethods.portal.bizPolicy.biz.directory.IDirectoryPolicy, Constant Field Values

USER_POLICY

static final String USER_POLICY
Deprecated. use IBizPolicyNames#USER instead.
BizPolicy for manipulating data on user objects.

See Also:
com.webmethods.portal.bizPolicy.biz.directory.IUserPolicy, Constant Field Values

INSTALL_POLICY

static final String INSTALL_POLICY
Deprecated. use IBizPolicyNames.INSTALL instead.
BizPolicy for controlling installation and upgrade system.

See Also:
IInstallPolicy, Constant Field Values
Method Detail

getBizPolicy

IBizPolicy getBizPolicy(String bizPolicyName)
                        throws BizException

Retrieve an IBizPolicy by name. You can use the IBizPolicyNames (recommended) or the defines in IBizPolicyManager.

In order to use the IBizPolicy, cast the returned object to the specific interface. For example: IBasicPolicy.

Parameters:
bizPolicyName - the name of the registered business policy.
Returns:
the bizPolicy requested.
Throws:
BizException - if unable to find the requested bizPolicy interface.

getBizPolicy

IBizPolicy getBizPolicy(IURI uri)
                        throws BizException

Returns an appropriate interface for the specified resource. So for example, if you have an IThingID, this will return the appropriate interface such as IContainerPolicy if the resource happens to be an com.webmethods.portal.service.meta2.storage.IContainer.

Parameters:
uri - the IURI of the resource
Returns:
the bizPolicy requested.
Throws:
BizException - if unable to find the appropriate bizPolicy interface.