Package com.webmethods.portal.mech.rules

Interface IPortalRulesMechanics

All Superinterfaces:

IAccessMechanics, IBasicMechanics, IClipboardMechanics, IComponent, IInitializable, IMechanics, IRuleMechanics, ISubscribableMechanics, ISystemHandler, IViewableMechanics

public interface IPortalRulesMechanics
extends IRuleMechanics

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALIASES
static final String	ATTR_ID	various attributes
static final String	ATTR_LEGACY
static final String	ATTR_ORIG_TEXT
static final String	ATTR_PARENT_ID
static final String	ATTR_RULE_EDITING_CONTEXT
static final String	ATTRIBUTE
static final String	CAF	Calls made to a custom caf object
static final String	CONTEXT	The current context object
static final String	CONTEXT_LOCALE_RULE
static final String	CONTEXT_LOGIN_RULE
static final String	CONTEXT_RENDERER_RULE
static final String	CONTEXT_RESPONSE_HEADERS_RULE
static final String	CONTEXT_SHELL_RULE	Well known contexts
static final String	CONTEXT_SKIN_RULE
static final String	CONTEXT_START_PAGE_RULE
static final String	DEFAULT_RULE_EDITING_CONTEXT	Default Rule Editing context for portal rules
static final String	DOMAIN	The following are properties available on the user
static final String	GROUP_DNS
static final String	HEADER	The following are properties available on the request
static final String	IS_DESCENDANT	Comparators
static final String	PORTAL_RESOURCE	The request object is the current resource that will be available on all IRuleContext's if the defaults are taken
static final String	REQUEST	The request object is the ServletRequest that will be available on all IRuleContext's if the defaults are taken
static final String	ROLE_DNS
static final String	STORAGE_LOCALE_RULE
static final String	STORAGE_LOGIN_RULE
static final String	STORAGE_RENDERER_RULE
static final String	STORAGE_RESPONSE_HEADERS_RULE
static final String	STORAGE_SHELL_RULE	Well known rule storage folders
static final String	STORAGE_SKIN_RULE
static final String	STORAGE_START_PAGE_RULE
static final String	TYPE	The following are properties available on the resource
static final String	USER	The user object is the IDirUser that will be available on all IRuleContext's if the defaults are taken
static final String	VIEW

Fields inherited from interface com.webmethods.portal.mech.access.IAccessMechanics

ACCESS_DENIED, ACCESS_GRANTED, ACCESS_RIGHT_ID, ACCESS_RIGHT_LONG_NAME, ACCESS_RIGHT_SHORT_NAME, ACCESS_RIGHTS_CONTAINER, ACCESS_UNSPECIFIED, AUTH_LEVEL_ANONYMOUS, AUTH_LEVEL_BASIC, AUTH_LEVEL_DEFAULT, AUTH_LEVEL_FULL_ACCESS, AUTH_LEVEL_KERBEROS, AUTH_LEVEL_NTLM, AUTH_LEVEL_PROPERTY

Fields inherited from interface com.webmethods.portal.mech.storage.IBasicMechanics

PROP_CUSTOM_FILE_ENCODING, PROP_FILE_ENCODING, TITLEBAR_ACTION_SHOW_ADD_TO_HOME, TITLEBAR_ACTION_SHOW_DISPLAY_OPTIONS, TITLEBAR_ACTION_SHOW_MAXIMIZED, TITLEBAR_ACTION_SHOW_MINIMIZED, TITLEBAR_ACTION_SHOW_NORMAL

Fields inherited from interface com.webmethods.portal.mech.subscription.ISubscribableMechanics

CONTENT_FORMAT_EMAIL, CONTENT_FORMAT_EMAIL_DIGEST, CONTENT_FORMAT_PORTAL_INBOX, CONTENT_FORMAT_PORTAL_INBOX_DIGEST, HEADER_FROM, HEADER_SUBJECT, HEADER_TO

Fields inherited from interface com.webmethods.portal.mech.view.IViewableMechanics

COMMENTS_LINK_TYPE, CONTENT_LINK_TYPE, DEFAULT_ORDER, DEFAULT_PAGE_SIZE, DEFAULT_SORT, DETAILS_LINK_TYPE, LARGE_ICON_TYPE, LINK_TYPE, LINK_TYPE_COMMENTS, LINK_TYPE_CONTENT, LINK_TYPE_DETAILS, LINK_TYPE_EDIT, LINK_TYPE_HELP, LINK_TYPE_HELP_MAXIMIZED, LINK_TYPE_MAXIMIZED, LINK_TYPE_MINIMIZED, LINK_TYPE_PERMISSIONS, LINK_TYPE_PORTAL_CONTENT, LINK_TYPE_PORTLET_STANDALONE, LINK_TYPE_PROPERTIES, LINK_TYPE_RESTORED, LINK_TYPE_SUBSCRIPTIONS, LINK_TYPE_THUMBNAILS, LINK_TYPE_VERSIONS, PERMISSIONS_LINK_TYPE, PORTAL_CONTENT_LINK_TYPE, PROPERTIES_LINK_TYPE, PROPERTY_LINK_TARGET, PROPERTY_OWNER_NAME, PROPERTY_PARENT_NAME, PROPERTY_TOOLTIP, REFERENCE_ICON_TYPE, SUBSCRIPTIONS_LINK_TYPE, THUMBNAIL_ICON_TYPE, THUMBNAILS_LINK_TYPE, VERSIONS_LINK_TYPE

Method Summary

Modifier and Type	Method	Description
com.webmethods.caf.rules.IRuleBuilder	getRuleBuilder(boolean addPortalContext)	Generate a default rule builder
com.webmethods.caf.rules.IRuleContext	getRuleContext(boolean addPortalContext)	Generate a default rule context
com.webmethods.caf.rules.IRuleContext	getRuleContext(boolean addPortalContext, IURI userURI)	Generate a default rule context
IPortalRuleEditingContext	getRuleEditingContext(IURI ruleURI)	Need to acquire the IPortalRuleEditingContext in order to edit a rule
IPortalRuleEditingContext	getRuleEditingContext(String ruleEditingContextURI)	Attempt to acquire an instance based of a URI
com.webmethods.caf.rules.IRule	getRuleFromThingID(com.webmethods.caf.rules.IRuleBuilder ruleBuilder, IThingID thingID)	Acquire a rule based on the thingID using the supplied rulebuilder
com.webmethods.caf.rules.IRule	getRuleFromView(com.webmethods.caf.rules.IRuleBuilder ruleBuilder, IRuleView ruleView)	Acquire a rule based on a ruleView
IThingID	getRuleThingID(com.webmethods.caf.rules.IRule rule)	Get the thing id of a rule

Methods inherited from interface com.webmethods.portal.mech.access.IAccessMechanics

canRemoveSecurityRealm, canSetSecurityRealm, checkAccess, checkAccessEx, checkRemoveSecurityRealm, checkSetSecurityRealm, cloneAces, fireRemoveAcccesEvent, fireRemoveSecurityRealmEvent, fireSetAccessEvent, fireSetAuthenticationEvent, fireSetOwnerEvent, fireSetSecurityRealmEvent, getAccessEx, getAccessList, getAccessListEx, getAclView, getAuthLevelForAuthScheme, getAuthScheme, getAuthSchemeForAuthLevel, getAuthSchemeForResource, getAvailableAuthSchemes, getDefaultAuthScheme, getRightNameForValue, getRightsForType, getRightValueForName, getSecurityRealm, invalidateAcesForThing, invalidateAcesForUser, listSecurityRealmObjects, removeAces, removeSecurityRealm, setAces, setAcesEx, setSecurityRealm, setSecurityRealm

Methods inherited from interface com.webmethods.portal.mech.storage.IBasicMechanics

addNote, addReference, addRelation, canAddNote, canCloneRemote, canCreate, canDelete, canDestroy, canDoTitlebarAction, canListAccess, canListContainers, canListNotes, canRemoveAccess, canRemoveNote, canSetAccess, canSetAuthentication, canSetOwner, canUninstall, canUpdateContent, canUpdateProperties, canVerb, canViewAuthentication, canViewContent, checkAddNote, checkCloneRemote, checkCreate, checkDelete, checkDestroy, checkListAccess, checkListContainers, checkListNotes, checkRemoveAccess, checkRemoveNote, checkSetAccess, checkSetAuthentication, checkSetOwner, checkUninstall, checkUpdateContent, checkUpdateProperties, checkViewAuthentication, checkViewContent, cloneRemote, copy, create, create, delete, destroy, doAfterInstall, doAfterUpgrade, doBeforeUninstall, doBeforeUpgrade, fireAddNoteEvent, fireCacheInvalidateEvent, fireDeleteEvent, fireInsoEvent, fireListAccessEvent, fireListContainersEvent, fireListNotesEvent, firePurgeEvent, fireRemoveAcccesEvent, fireRemoveNoteEvent, fireSetAccessEvent, fireSetAuthenticationEvent, fireSetOwnerEvent, fireUpdateContentEvent, fireUpdatePropertiesEvent, fireViewAuthenticationEvent, fireViewContentEvent, getAccess, getAncestors, getAuthentication, getContent, getContent, getContentStore, getContentStore, getDependencyList, getPrimaryRelatedChild, getPrimaryRelatedContainer, getTimeToLive, isAnonymous, isBaseType, isContainer, isNormal, isReference, isVersionable, isWorkflowEnabled, listAccess, listAccess, listContainers, listContainers, listDependants, listNotes, listRelatedChildren, listRelatedContainers, move, move, prepareForDeletion, removeNote, removeReference, removeRelation, restoreXTypeConfProps, saveXTypeConfProps, setAuthentication, setOwner, setTimeToLive, undeleteAllUndestroyed, updateContent, updateContent, updateProperties, updateProperties

Methods inherited from interface com.webmethods.portal.mech.clipboard.IClipboardMechanics

canCopyToClipboard, canCutToClipboard, checkCopyToClipboard, checkCutToClipboard, copyToClipboard, cutToClipboard, getClipboard, getClipboardInfo, newClipboardItem

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Methods inherited from interface com.webmethods.portal.mech.rules.IRuleMechanics

evaluateQuery, getAllMatchingRulesForUser, getOrderedRules, getRuleForUser, getRuleResultForUser, getTargetURI

Methods inherited from interface com.webmethods.portal.mech.subscription.ISubscribableMechanics

canDeliverToPrincipal, canEditSubscription, canListSubscriptions, canViewSubscription, checkEditSubscription, checkListSubscriptions, checkViewSubscription, checkViewSubscription, createAppCriteria, createAppCriteriaFolder, createPortletSubscription, createPortletSubscription, disable, disable, disableBySystem, disableBySystem, enable, enable, fireGetAppCriteriaEvent, fireGetSubscriptionEvent, fireSetSubscriptionEvent, fireUnsubscribeEvent, fireViewSubscriptionEvent, generateNotificationContent, generateNotificationHeaders, getAppCriteria, getGroupSubscription, getSubscription, listSubscriptions, listSubscriptions, setGroupSubscription, setGroupSubscription, setSubscription, setSubscription, unsubscribe, unsubscribe, viewSubscription

Methods inherited from interface com.webmethods.portal.mech.view.IViewableMechanics

canView, checkView, createPagingCookie, fireViewEvent, getCss, getCss, getDefaultLinkType, getFormattedProperty, getHierachicalUri, getIcon, getIcon, getLink, getLink, getListProperty, getListPropertyHTML, getListPropertyJS, isEnabled, view, view

Field Details

USER

static final String USER

The user object is the IDirUser that will be available on all IRuleContext's if the defaults are taken

See Also:

• Constant Field Values

REQUEST

static final String REQUEST

The request object is the ServletRequest that will be available on all IRuleContext's if the defaults are taken

See Also:

• Constant Field Values

PORTAL_RESOURCE

static final String PORTAL_RESOURCE

The request object is the current resource that will be available on all IRuleContext's if the defaults are taken

See Also:

• IContext.getCurrentResource()
• Constant Field Values

CONTEXT

static final String CONTEXT

The current context object

See Also:

• IContext
• Constant Field Values

CAF

static final String CAF

Calls made to a custom caf object

See Also:

• Constant Field Values

DOMAIN

static final String DOMAIN

The following are properties available on the user

See Also:

• Constant Field Values

GROUP_DNS

static final String GROUP_DNS

See Also:

• Constant Field Values

ROLE_DNS

static final String ROLE_DNS

See Also:

• Constant Field Values

ATTRIBUTE

static final String ATTRIBUTE

See Also:

• Constant Field Values

HEADER

static final String HEADER

The following are properties available on the request

See Also:

• Constant Field Values

TYPE

static final String TYPE

The following are properties available on the resource

See Also:

• Constant Field Values

VIEW

static final String VIEW

See Also:

• Constant Field Values

ALIASES

static final String ALIASES

See Also:

• Constant Field Values

ATTR_ID

static final String ATTR_ID

various attributes

See Also:

• Constant Field Values

ATTR_LEGACY

static final String ATTR_LEGACY

See Also:

• Constant Field Values

ATTR_ORIG_TEXT

static final String ATTR_ORIG_TEXT

See Also:

• Constant Field Values

ATTR_PARENT_ID

static final String ATTR_PARENT_ID

See Also:

• Constant Field Values

ATTR_RULE_EDITING_CONTEXT

static final String ATTR_RULE_EDITING_CONTEXT

See Also:

• Constant Field Values

CONTEXT_SHELL_RULE

static final String CONTEXT_SHELL_RULE

Well known contexts

See Also:

• Constant Field Values

CONTEXT_SKIN_RULE

static final String CONTEXT_SKIN_RULE

See Also:

• Constant Field Values

CONTEXT_LOGIN_RULE

static final String CONTEXT_LOGIN_RULE

See Also:

• Constant Field Values

CONTEXT_RENDERER_RULE

static final String CONTEXT_RENDERER_RULE

See Also:

• Constant Field Values

CONTEXT_START_PAGE_RULE

static final String CONTEXT_START_PAGE_RULE

See Also:

• Constant Field Values

CONTEXT_LOCALE_RULE

static final String CONTEXT_LOCALE_RULE

See Also:

• Constant Field Values

CONTEXT_RESPONSE_HEADERS_RULE

static final String CONTEXT_RESPONSE_HEADERS_RULE

See Also:

• Constant Field Values

STORAGE_SHELL_RULE

static final String STORAGE_SHELL_RULE

Well known rule storage folders

See Also:

• Constant Field Values

STORAGE_SKIN_RULE

static final String STORAGE_SKIN_RULE

See Also:

• Constant Field Values

STORAGE_LOGIN_RULE

static final String STORAGE_LOGIN_RULE

See Also:

• Constant Field Values

STORAGE_RENDERER_RULE

static final String STORAGE_RENDERER_RULE

See Also:

• Constant Field Values

STORAGE_START_PAGE_RULE

static final String STORAGE_START_PAGE_RULE

See Also:

• Constant Field Values

STORAGE_LOCALE_RULE

static final String STORAGE_LOCALE_RULE

See Also:

• Constant Field Values

STORAGE_RESPONSE_HEADERS_RULE

static final String STORAGE_RESPONSE_HEADERS_RULE

See Also:

• Constant Field Values

IS_DESCENDANT

static final String IS_DESCENDANT

Comparators

See Also:

• Constant Field Values

DEFAULT_RULE_EDITING_CONTEXT

static final String DEFAULT_RULE_EDITING_CONTEXT

Default Rule Editing context for portal rules

See Also:

• Constant Field Values

Method Details

getRuleBuilder

com.webmethods.caf.rules.IRuleBuilder getRuleBuilder(boolean addPortalContext)
                                              throws PortalException

Generate a default rule builder

Parameters:

addDefaultPortalContext - whether to prepare the rule builder with standard objects

Throws:

PortalException

getRuleContext

com.webmethods.caf.rules.IRuleContext getRuleContext(boolean addPortalContext)
                                              throws PortalException

Generate a default rule context

Parameters:

addDefaultPortalContext - whether to prepare the rule context with standard objects

Throws:

PortalException

getRuleContext

com.webmethods.caf.rules.IRuleContext getRuleContext(boolean addPortalContext,
 IURI userURI)
                                              throws PortalException

Generate a default rule context

Parameters:

addDefaultPortalContext - whether to prepare the rule context with standard objects

the - uri of the user to add to the context (only valid of addPortalContext is true)

Throws:

PortalException

getRuleFromThingID

com.webmethods.caf.rules.IRule getRuleFromThingID(com.webmethods.caf.rules.IRuleBuilder ruleBuilder,
 IThingID thingID)
                                           throws PortalException

Acquire a rule based on the thingID using the supplied rulebuilder

Throws:

PortalException

getRuleFromView

com.webmethods.caf.rules.IRule getRuleFromView(com.webmethods.caf.rules.IRuleBuilder ruleBuilder,
 IRuleView ruleView)
                                        throws PortalException

Acquire a rule based on a ruleView

Throws:

PortalException

getRuleEditingContext

IPortalRuleEditingContext getRuleEditingContext(IURI ruleURI)
                                         throws PortalException

Need to acquire the IPortalRuleEditingContext in order to edit a rule

Throws:

PortalException

getRuleEditingContext

IPortalRuleEditingContext getRuleEditingContext(String ruleEditingContextURI)
                                         throws PortalException

Attempt to acquire an instance based of a URI

Throws:

PortalException

getRuleThingID

IThingID getRuleThingID(com.webmethods.caf.rules.IRule rule)
                 throws PortalException

Get the thing id of a rule

Throws:

PortalException