IBasicMechanics (server-common-api)

All Superinterfaces:

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

All Known Subinterfaces:

IContainerContentConstraintMechanics, IContainerMechanics, IContentMechanics, IFolderMechanics, ILinkMechanics, ILocalePortletMechanics, IPortalRulesMechanics, IPortletMechanics, IRuleMechanics, IScheduleMechanics, ISkinMechanics, ITaskMechanics, ITaskScheduleMechanics, ITemplateMechanics, ITopicMechanics, IVersionableMechanics, IXTypeMechanics
```
public interface IBasicMechanics
extends IClipboardMechanics, IAccessMechanics
```
Mechanics for a basic metadata thing.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PROP_CUSTOM_FILE_ENCODING` Property that controls custom user defined file encoding.
`static String`	`PROP_FILE_ENCODING` Property that controls file encoding.
`static String`	`TITLEBAR_ACTION_SHOW_ADD_TO_HOME` Portlet and DBO titlebar action to add object to the home page
`static String`	`TITLEBAR_ACTION_SHOW_DISPLAY_OPTIONS` Portlet and DBO titlebar action to add object to the home page
`static String`	`TITLEBAR_ACTION_SHOW_MAXIMIZED` Portlet and DBO titlebar action to show object maximized
`static String`	`TITLEBAR_ACTION_SHOW_MINIMIZED` Portlet and DBO titlebar action to show object minimized view
`static String`	`TITLEBAR_ACTION_SHOW_NORMAL` Portlet and DBO titlebar action to show object normal view

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.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

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addNote(IThingID itemId, IThingID userId, String note)` Adds a comment to an item.
`void`	`addReference(IThingID containerId, IThingID childId)` Adds a reference to the specified item into the specified container.
`void`	`addRelation(IThingID containerId, IThingID childId, String relType)` Add relation between containerID and childID using specified relType
`boolean`	`canAddNote(IThingID itemId, IThingID userId)` Returns true if the specified user can add a note to the specified item.
`boolean`	`canCloneRemote(IThingID destContainerId, IThingID srcItemId, IThingID userId)` Returns true if the specified user can clone the specified item.
`boolean`	`canCreate(IThingID xtypeId, IThingID userId)` Returns true if the specified user can create the specified type of item.
`boolean`	`canDelete(IThingID itemId, IThingID userId)` Returns true if the specified user can delete the specified item.
`boolean`	`canDestroy(IThingID thingID, IThingID userID)` Returns true if user can destroy an item.
`boolean`	`canDoTitlebarAction(IThingID thingID, String titlebarAction)` Titlebar implementation may an object if it supports certain titlebar defined action
`boolean`	`canListAccess(IThingID itemId, IThingID userId, Map<?,?> capabilities)` Returns true if the specified user can view the access list (of principals) of the specified item.
`boolean`	`canListContainers(IThingID itemId, IThingID userId, Map<?,?> capabilities)` Returns true if the specified user can view the containers of the specified item.
`boolean`	`canListNotes(IThingID itemId, IThingID userId, Map<?,?> capabilities)` Returns true if the specified user can view the notes associated with the specified item.
`boolean`	`canRemoveAccess(IThingID itemId, IThingID userId, boolean recursive)` Returns true if the specified user can remove entries from the access list of the specified item.
`boolean`	`canRemoveNote(IThingID itemId, IThingID userId)` Returns true if the specified user can remove a note from the specified item.
`boolean`	`canSetAccess(IThingID itemId, IThingID userId, boolean recursive)` Returns true if the specified user can add or modify entries in the access list of the specified item.
`boolean`	`canSetAuthentication(IThingID itemId, IThingID userId, boolean recursive)` Returns true if the specified user can set the authentication type of the specified item.
`boolean`	`canSetOwner(IThingID itemId, IThingID userId)` Returns true if the specified user can set the owner of the specified item.
`boolean`	`canUninstall(IThingID itemID)` Check to see if item can be uninstalled.
`boolean`	`canUpdateContent(IThingID itemId, IThingID userId)` Returns true if the specified user can update the content of the specified item.
`boolean`	`canUpdateProperties(IThingID itemId, IThingID userId)` Returns true if the specified user can update the properties of the specified item.
`boolean`	`canVerb(IURI itemURI, IURI userURI, String verb, Object param)` Checks if given user could perform given operation (verb) on given object
`boolean`	`canViewAuthentication(IThingID itemId, IThingID userId, Map<?,?> capabilities)` Returns true if the specified user can view the authentication method of the specified item.
`boolean`	`canViewContent(IThingID itemId, IThingID userId, Map<?,?> capabilities)` Returns true if the specified user can view the content of the specified item.
`void`	`checkAddNote(IThingID itemId, IThingID userId)` Throws a `PortalAccessException` if the specified user cannot add a note to the specified item.
`void`	`checkCloneRemote(IThingID destContainerId, IThingID srcItemId, IThingID userId)` Throws a `PortalAccessException` if the specified user cannot clone the specified item.
`void`	`checkCreate(IThingID xtypeId, IThingID userId)` Throws a `PortalAccessException` if the specified user cannot create the specified type of item.
`void`	`checkDelete(IThingID itemId, IThingID userId)` Throws a `PortalAccessException` if the specified user cannot delete the specified item.
`void`	`checkDestroy(IThingID thingID, IThingID userID)` Throws `PortalAccessException` if the user can not destroy an item.
`void`	`checkListAccess(IThingID itemId, IThingID userId, Map<?,?> capabilities)` Throws a `PortalAccessException` if the specified user cannot view the access list (of principals) of the specified item.
`void`	`checkListContainers(IThingID itemId, IThingID userId, Map<?,?> capabilities)` Throws a `PortalAccessException` if the specified user cannot view the containers of the specified item.
`void`	`checkListNotes(IThingID itemId, IThingID userId, Map<?,?> capabilities)` Throws a `PortalAccessException` if the specified user cannot view the notes associated with the specified item.
`void`	`checkRemoveAccess(IThingID itemId, IThingID userId, boolean recursive)` Throws a `PortalAccessException` if the specified user cannot remove entries from the access list of the specified item.
`void`	`checkRemoveNote(IThingID itemId, IThingID userId)` Throws a `PortalAccessException` if the specified user cannot remove a note from the specified item.
`void`	`checkSetAccess(IThingID itemId, IThingID userId, boolean recursive)` Throws a `PortalAccessException` if the specified user cannot add or modify entries in the access list of the specified item.
`void`	`checkSetAuthentication(IThingID itemId, IThingID userId, boolean recursive)` Throws a `PortalAccessException` if the specified user cannot set the authentication type of the specified item.
`void`	`checkSetOwner(IThingID itemId, IThingID userId)` Throws a `PortalAccessException` if the specified user cannot set the owner of the specified item.
`void`	`checkUninstall(IThingID itemID)` Check to see if an item can be uninstalled.
`void`	`checkUpdateContent(IThingID itemId, IThingID userId)` Throws a `PortalAccessException` if the specified user cannot update the content of the specified item.
`void`	`checkUpdateProperties(IThingID itemId, IThingID userId)` Throws a `PortalAccessException` if the specified user cannot update the properties of the specified item.
`void`	`checkViewAuthentication(IThingID itemId, IThingID userId, Map<?,?> capabilities)` Throws a `PortalAccessException` if the specified user cannot view the authentication method of the specified item.
`void`	`checkViewContent(IThingID itemId, IThingID userId, Map<?,?> capabilities)` Throws a `PortalAccessException` if the specified user cannot view the content of the specified item.
`IThingID`	`cloneRemote(IThingID destContainerId, IThingID srcItemId, IThingID userId, Map<String,?> maps)` Clones remote item in the specified destination container.
`IThingID`	`copy(IThingID containerId, IThingID userId, IThingID childId)` Creates a new copy of the specified child in the specified container.
`IThingID`	`create(IThingID containerId, IThingID userId, int xtype, Map<String,? extends Object> properties)` Deprecated.
`IThingID`	`create(IThingID containerId, IThingID userId, int xtype, Map<String,? extends Object> properties, Locale locale)` Creates a new item of the specified xtype in the specified container.
`void`	`delete(IThingID itemId)` Deletes the specified item, and if the item is a container, the container's descendants.
`void`	`destroy(IThingID itemID)` Destroys the specified item and all of its descendants.
`void`	`doAfterInstall(IThingID itemID)` Actions to perform after installation.
`void`	`doAfterUpgrade(IThingID itemID)` Actions to perform after upgrade.
`void`	`doBeforeUninstall(IThingID itemID)` Actions to be performed before an uninstall.
`void`	`doBeforeUpgrade(IThingID itemID)` Actions to perform before upgrade.
`void`	`fireAddNoteEvent(IThingID itemId, IThingID userId, int status)` Fires an add notes event.
`void`	`fireCacheInvalidateEvent(IThingID itemId, IThingID userId)` Fires an invalidate cache event.
`void`	`fireDeleteEvent(IThingID itemId, IThingID containerId, IThingID userId, int status)` Fires a delete event.
`void`	`fireInsoEvent(IThingID itemId, IThingID userId)` Fires an Inso event.
`void`	`fireListAccessEvent(IThingID itemId, IThingID userId, int status)` Fires a list access event.
`void`	`fireListContainersEvent(IThingID itemId, IThingID userId, int status)` Fires a list containers event.
`void`	`fireListNotesEvent(IThingID itemId, IThingID userId, int status)` Fires a list notes event.
`void`	`firePurgeEvent(IThingID itemID, IThingID containerID, IThingID userID)` Fires thing purge event.
`void`	`fireRemoveAcccesEvent(IThingID itemId, IThingID userId, int status, List<? extends IURI> principalIds)` Fires a remove access event.
`void`	`fireRemoveNoteEvent(IThingID itemId, IThingID userId, int status)` Fires a remove notes event.
`void`	`fireSetAccessEvent(IThingID itemId, IThingID userId, int status, List<? extends IURI> principalIds)` Fires a set access event.
`void`	`fireSetAuthenticationEvent(IThingID itemId, IThingID userId, int status, String scheme)` Fires a set authentication event.
`void`	`fireSetOwnerEvent(IThingID itemId, IThingID userId, int status, IThingID newOwnerId, IThingID oldOwnerId)` Fires a set owner event.
`void`	`fireUpdateContentEvent(IThingID itemId, IThingID userId, int status, DifferenceMap differences)` Fires an update content event.
`void`	`fireUpdatePropertiesEvent(IThingID itemId, IThingID userId, int status, DifferenceMap differences)` Fires an update properties event.
`void`	`fireViewAuthenticationEvent(IThingID itemId, IThingID userId, int status)` Fires a view authentication event.
`void`	`fireViewContentEvent(IThingID itemId, IThingID userId, int status)` Fires a view content event.
`int`	`getAccess(IThingID itemId, IThingID userId, Map<?,?> capabilities)` Returns the bit set representing the access rights the specified user has for the specified item.
`IThingIDList`	`getAncestors(IThingID itemId)` Returns the list of ancestors (ie the parent hierarchy) for the specified item.
`String`	`getAuthentication(IThingID itemId)` Returns the authentication scheme name for the specified item.
`InputStream`	`getContent(IThingID itemId)` Returns the content stream for the specified item.
`InputStream`	`getContent(IThingID itemId, String type)` Returns the content stream of a particular type for the specified item.
`IContentStore`	`getContentStore(IThingID itemId)` Returns the content store for the specified item.
`IContentStore`	`getContentStore(IThingID itemId, String type)` Returns the content store of a particular type for the specified item.
`IThingIDList`	`getDependencyList(IThingID thingID, IThingIDList mergeList)` Get the dependency list for this item.
`IThingID`	`getPrimaryRelatedChild(IThingID containerID, String relType)` Returns first normal related child of specified relationship type.
`IThingID`	`getPrimaryRelatedContainer(IThingID childID, String relType)` Returns first normal related container of specified relationship type.
`long`	`getTimeToLive()` Deprecated. not used in 8.x+
`boolean`	`isAnonymous(IThingID itemId)` Returns true if the specified item allows anonymous access.
`boolean`	`isBaseType(IThingID itemId)` Returns true if the specified item's xtype is the base for its type.
`boolean`	`isContainer(IThingID itemId)` Returns true if the specified item is a container.
`boolean`	`isNormal(IThingID itemId)` Returns true if the specified item is normal (not deleted/archived/etc).
`boolean`	`isReference(IView view)` Returns true if the specified view represents a reference to an item, rather than the item itself.
`boolean`	`isVersionable(IThingID itemId)` Returns true if the specified item is versionable.
`boolean`	`isWorkflowEnabled(IThingID userID, IThingID containerId)` Deprecated. not used anymore
`IListView<IView>`	`listAccess(IThingID itemId)` Returns a list of access control entries for the specified item.
`IListView<IView>`	`listAccess(IThingID itemId, IThingID userId)` Returns a list of access control entries for the specified item, filtered for the specified user.
`IListView<IView>`	`listContainers(IThingID itemId)` Returns a list of containers that reference the specified item.
`IListView<IView>`	`listContainers(IThingID itemId, IThingID userId)` Returns a list of containers that reference the specified item, filtered for the specified user.
`IListView<IView>`	`listDependants(IThingID itemId)` Lists all items that depend on this item, including this item.
`IListView<INote>`	`listNotes(IThingID itemId, IThingID userId)` Returns a list of notes for the comments page, filtered for the specified user.
`IThingIDList`	`listRelatedChildren(IThingID containerID, String relType, int start, int end)` Returns list of thing IDs of all related things to the specified container
`IThingIDList`	`listRelatedContainers(IThingID childID, String relType, int start, int end)` Returns list of thing IDs of containers that contain specified child with relationship type
`void`	`move(IThingID containerId, IThingID childId)` Moves the specified item into the specified container.
`void`	`move(IThingID containerId, IThingID childId, String newName)` Moves and renames the specified item into the specified container.
`void`	`prepareForDeletion(IThingID itemId)` Prepares the specified item to be deleted as part of a recursive deletion operation initiated on one of the item's ancestors (or the item itself).
`void`	`removeNote(IThingID itemId, IThingID userId, int noteID)` Removes a comment from an item.
`void`	`removeReference(IThingID containerId, IThingID childId)` Removes the reference to the specified item from the specified container.
`void`	`removeRelation(IThingID containerId, IThingID childId, String relType)` Counterpart to addRelation method.
`void`	`setAuthentication(IThingID itemId, String authLevel, boolean recursive)` Sets the authentication scheme name for the specified item.
`void`	`setOwner(IThingID itemId, IThingID ownerId)` Sets the owner of the specified item.
`void`	`setTimeToLive(long timeToLive)` Deprecated. not used in 8.x+
`IThingIDList`	`undeleteAllUndestroyed()` Attempts to undelete all things that are in the "undestroyed" state.
`void`	`updateContent(IThingID itemId, IThingID userId, boolean insoConvert, IPortalFileBean portalFileBean, String encoding)` Updates the content of the specified item for the specified user.
`void`	`updateContent(IThingID itemId, IThingID userId, InputStream content, String type, boolean insoConvert, String originalPath)` Updates the content of the specified item for the specified user.
`DifferenceMap`	`updateProperties(IThingID itemId, IThingID userId, Map<String,? extends Object> properties)` Deprecated.
`DifferenceMap`	`updateProperties(IThingID itemId, IThingID userId, Map<String,? extends Object> properties, Locale locale)` Updates properties

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.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, isEnabled, view, view

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

- Field Detail
  - TITLEBAR_ACTION_SHOW_NORMAL
```
static final String TITLEBAR_ACTION_SHOW_NORMAL
```
    Portlet and DBO titlebar action to show object normal view
    
    See Also:
    
    Constant Field Values
  - TITLEBAR_ACTION_SHOW_MINIMIZED
```
static final String TITLEBAR_ACTION_SHOW_MINIMIZED
```
    Portlet and DBO titlebar action to show object minimized view
    
    See Also:
    
    Constant Field Values
  - TITLEBAR_ACTION_SHOW_MAXIMIZED
```
static final String TITLEBAR_ACTION_SHOW_MAXIMIZED
```
    Portlet and DBO titlebar action to show object maximized
    
    See Also:
    
    Constant Field Values
  - TITLEBAR_ACTION_SHOW_ADD_TO_HOME
```
static final String TITLEBAR_ACTION_SHOW_ADD_TO_HOME
```
    Portlet and DBO titlebar action to add object to the home page
    
    See Also:
    
    Constant Field Values
  - TITLEBAR_ACTION_SHOW_DISPLAY_OPTIONS
```
static final String TITLEBAR_ACTION_SHOW_DISPLAY_OPTIONS
```
    Portlet and DBO titlebar action to add object to the home page
    
    See Also:
    
    Constant Field Values
  - PROP_FILE_ENCODING
```
static final String PROP_FILE_ENCODING
```
    Property that controls file encoding. Should be valid Java encoding string. "system" means current JVM encoding
    
    See Also:
    
    Constant Field Values
  - PROP_CUSTOM_FILE_ENCODING
```
static final String PROP_CUSTOM_FILE_ENCODING
```
    Property that controls custom user defined file encoding. Should be a valid Java encoding string.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - canViewContent
```
boolean canViewContent(IThingID itemId,
                       IThingID userId,
                       Map<?,?> capabilities)
                throws PortalException
```
    Returns true if the specified user can view the content of the specified item.
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    capabilities - Known set of capabilities for this user. May be null, in which case they'll be looked up from the IContext.SCOPE_REQUEST attributes on the user's IContext.
    
    Returns:
    
    True if user can view the content of the item, false if they can't.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - checkViewContent
```
void checkViewContent(IThingID itemId,
                      IThingID userId,
                      Map<?,?> capabilities)
               throws PortalException,
                      PortalAccessException
```
    Throws a PortalAccessException if the specified user cannot view the content of the specified item.
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    capabilities - Known set of capabilities for this user. May be null, in which case they'll be looked up from the IContext.SCOPE_REQUEST attributes on the user's IContext.
    
    Throws:
    
    PortalAccessException - if the user cannot view the content of the item.
    
    PortalException - if the userId is invalid.
  - canListContainers
```
boolean canListContainers(IThingID itemId,
                          IThingID userId,
                          Map<?,?> capabilities)
                   throws PortalException
```
    Returns true if the specified user can view the containers of the specified item.
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    capabilities - Known set of capabilities for this user. May be null, in which case they'll be looked up from the IContext.SCOPE_REQUEST attributes on the user's IContext.
    
    Returns:
    
    True if user can view the containers of the item, false if they can't.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - checkListContainers
```
void checkListContainers(IThingID itemId,
                         IThingID userId,
                         Map<?,?> capabilities)
                  throws PortalException,
                         PortalAccessException
```
    Throws a PortalAccessException if the specified user cannot view the containers of the specified item.
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    capabilities - Known set of capabilities for this user. May be null, in which case they'll be looked up from the IContext.SCOPE_REQUEST attributes on the user's IContext.
    
    Throws:
    
    PortalAccessException - if the user cannot view the containers of the item.
    
    PortalException - if the userId is invalid.
  - canListNotes
```
boolean canListNotes(IThingID itemId,
                     IThingID userId,
                     Map<?,?> capabilities)
              throws PortalException
```
    Returns true if the specified user can view the notes associated with the specified item.
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    capabilities - Known set of capabilities for this user. May be null, in which case they'll be looked up from the IContext.SCOPE_REQUEST attributes on the user's IContext.
    
    Returns:
    
    True if user can view the notes associated with the item, false if they can't.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - checkListNotes
```
void checkListNotes(IThingID itemId,
                    IThingID userId,
                    Map<?,?> capabilities)
             throws PortalException,
                    PortalAccessException
```
    Throws a PortalAccessException if the specified user cannot view the notes associated with the specified item.
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    capabilities - Known set of capabilities for this user. May be null, in which case they'll be looked up from the IContext.SCOPE_REQUEST attributes on the user's IContext.
    
    Throws:
    
    PortalAccessException - if the user cannot view the notes associated with the item.
    
    PortalException - if the userId is invalid.
  - canListAccess
```
boolean canListAccess(IThingID itemId,
                      IThingID userId,
                      Map<?,?> capabilities)
               throws PortalException
```
    Returns true if the specified user can view the access list (of principals) of the specified item.
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    capabilities - Known set of capabilities for this user. May be null, in which case they'll be looked up from the IContext.SCOPE_REQUEST attributes on the user's IContext.
    
    Returns:
    
    True if the user has permission to view the access list, false if they don't.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - checkListAccess
```
void checkListAccess(IThingID itemId,
                     IThingID userId,
                     Map<?,?> capabilities)
              throws PortalException,
                     PortalAccessException
```
    Throws a PortalAccessException if the specified user cannot view the access list (of principals) of the specified item.
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    capabilities - Known set of capabilities for this user. May be null, in which case they'll be looked up from the IContext.SCOPE_REQUEST attributes on the user's IContext.
    
    Throws:
    
    PortalAccessException - if the user cannot view the access list of the item.
    
    PortalException - if the userId is invalid.
  - canViewAuthentication
```
boolean canViewAuthentication(IThingID itemId,
                              IThingID userId,
                              Map<?,?> capabilities)
                       throws PortalException
```
    Returns true if the specified user can view the authentication method of the specified item.
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    capabilities - Known set of capabilities for this user. May be null, in which case they'll be looked up from the IContext.SCOPE_REQUEST attributes on the user's IContext.
    
    Returns:
    
    True if the user can view the authentication method, False if they can't.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - checkViewAuthentication
```
void checkViewAuthentication(IThingID itemId,
                             IThingID userId,
                             Map<?,?> capabilities)
                      throws PortalException,
                             PortalAccessException
```
    Throws a PortalAccessException if the specified user cannot view the authentication method of the specified item.
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    capabilities - Known set of capabilities for this user. May be null, in which case they'll be looked up from the IContext.SCOPE_REQUEST attributes on the user's IContext.
    
    Throws:
    
    PortalAccessException - if the user cannot view the authentication method of the item.
    
    PortalException - if the userId is invalid.
  - canCreate
```
boolean canCreate(IThingID xtypeId,
                  IThingID userId)
           throws PortalException
```
    Returns true if the specified user can create the specified type of item.
    
    Parameters:
    
    xtypeId - IThingID of item type
    
    userId - IThingID of user
    
    Returns:
    
    True if the user can create this type of item, false if they can't.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - checkCreate
```
void checkCreate(IThingID xtypeId,
                 IThingID userId)
          throws PortalException,
                 PortalAccessException
```
    Throws a PortalAccessException if the specified user cannot create the specified type of item.
    
    Parameters:
    
    xtypeId - IThingID of item type
    
    userId - IThingID of user
    
    Throws:
    
    PortalAccessException - if the user cannot create this type of item.
    
    PortalException - if the userId is invalid.
  - canUpdateContent
```
boolean canUpdateContent(IThingID itemId,
                         IThingID userId)
                  throws PortalException
```
    Returns true if the specified user can update the content of the specified item.
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    Returns:
    
    True if user can update the content of the item, false if they can't.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - checkUpdateContent
```
void checkUpdateContent(IThingID itemId,
                        IThingID userId)
                 throws PortalException,
                        PortalAccessException
```
    Throws a PortalAccessException if the specified user cannot update the content of the specified item.
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    Throws:
    
    PortalAccessException - if the user cannot update the content of the item.
    
    PortalException - if the userId is invalid.
  - canUpdateProperties
```
boolean canUpdateProperties(IThingID itemId,
                            IThingID userId)
                     throws PortalException
```
    Returns true if the specified user can update the properties of the specified item.
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    Returns:
    
    True if the user can update the properties of the item, False if they can't.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - checkUpdateProperties
```
void checkUpdateProperties(IThingID itemId,
                           IThingID userId)
                    throws PortalException,
                           PortalAccessException
```
    Throws a PortalAccessException if the specified user cannot update the properties of the specified item.
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    Throws:
    
    PortalAccessException - if the user cannot update the properties of the item.
    
    PortalException - if the userId is invalid.
  - canDelete
```
boolean canDelete(IThingID itemId,
                  IThingID userId)
           throws PortalException
```
    Returns true if the specified user can delete the specified item.
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    Returns:
    
    True if the user can delete the item, False if they can't.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - checkDelete
```
void checkDelete(IThingID itemId,
                 IThingID userId)
          throws PortalException,
                 PortalAccessException
```
    Throws a PortalAccessException if the specified user cannot delete the specified item.
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    Throws:
    
    PortalAccessException - if the user cannot delete the item.
    
    PortalException - if the userId is invalid.
  - canAddNote
```
boolean canAddNote(IThingID itemId,
                   IThingID userId)
            throws PortalException
```
    Returns true if the specified user can add a note to the specified item.
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    Returns:
    
    True if the user can add a note to the item, false if they can't.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - checkAddNote
```
void checkAddNote(IThingID itemId,
                  IThingID userId)
           throws PortalException,
                  PortalAccessException
```
    Throws a PortalAccessException if the specified user cannot add a note to the specified item.
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    Throws:
    
    PortalAccessException - if the user cannot add a note to the item.
    
    PortalException - if the userId is invalid.
  - canRemoveNote
```
boolean canRemoveNote(IThingID itemId,
                      IThingID userId)
               throws PortalException
```
    Returns true if the specified user can remove a note from the specified item.
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    Returns:
    
    True if the user can remove a note from the item, false if they can't.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - checkRemoveNote
```
void checkRemoveNote(IThingID itemId,
                     IThingID userId)
              throws PortalException,
                     PortalAccessException
```
    Throws a PortalAccessException if the specified user cannot remove a note from the specified item.
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    Throws:
    
    PortalAccessException - if the user cannot remove a note from the item.
    
    PortalException - if the userId is invalid.
  - canSetOwner
```
boolean canSetOwner(IThingID itemId,
                    IThingID userId)
             throws PortalException
```
    Returns true if the specified user can set the owner of the specified item.
    
    Specified by:
    
    canSetOwner in interface IAccessMechanics
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    Returns:
    
    True if the user can set the owner of the item, False if they can't.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - checkSetOwner
```
void checkSetOwner(IThingID itemId,
                   IThingID userId)
            throws PortalException,
                   PortalAccessException
```
    Throws a PortalAccessException if the specified user cannot set the owner of the specified item.
    
    Specified by:
    
    checkSetOwner in interface IAccessMechanics
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    Throws:
    
    PortalAccessException - if the user cannot set the owner of the item.
    
    PortalException - if the userId is invalid.
  - canSetAccess
```
boolean canSetAccess(IThingID itemId,
                     IThingID userId,
                     boolean recursive)
              throws PortalException
```
    Returns true if the specified user can add or modify entries in the access list of the specified item.
    
    Specified by:
    
    canSetAccess in interface IAccessMechanics
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    recursive - True if we want to recursively check the item's descendants.
    
    rights - The rights set to check (see IAccessRight).
    
    Returns:
    
    True if the user can add or modify entries in the access list of the item, False if they can't.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - checkSetAccess
```
void checkSetAccess(IThingID itemId,
                    IThingID userId,
                    boolean recursive)
             throws PortalException,
                    PortalAccessException
```
    Throws a PortalAccessException if the specified user cannot add or modify entries in the access list of the specified item.
    
    Specified by:
    
    checkSetAccess in interface IAccessMechanics
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    recursive - True if we want to recursively check the item's descendants.
    
    rights - The rights set to check (see IAccessRight).
    
    Throws:
    
    PortalAccessException - if the user cannot add or modify entries in the access list of the item.
    
    PortalException - if the userId is invalid.
  - canRemoveAccess
```
boolean canRemoveAccess(IThingID itemId,
                        IThingID userId,
                        boolean recursive)
                 throws PortalException
```
    Returns true if the specified user can remove entries from the access list of the specified item.
    
    Specified by:
    
    canRemoveAccess in interface IAccessMechanics
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    recursive - True if we want to recursively check the item's descendants.
    
    Returns:
    
    True if the user can remove entries from the access list of the item, False if they can't.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - checkRemoveAccess
```
void checkRemoveAccess(IThingID itemId,
                       IThingID userId,
                       boolean recursive)
                throws PortalException,
                       PortalAccessException
```
    Throws a PortalAccessException if the specified user cannot remove entries from the access list of the specified item.
    
    Specified by:
    
    checkRemoveAccess in interface IAccessMechanics
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    recursive - True if we want to recursively check the item's descendants.
    
    Throws:
    
    PortalAccessException - if the user cannot remove entries from the access list of the item.
    
    PortalException - if the userId is invalid.
  - canSetAuthentication
```
boolean canSetAuthentication(IThingID itemId,
                             IThingID userId,
                             boolean recursive)
                      throws PortalException
```
    Returns true if the specified user can set the authentication type of the specified item.
    
    Specified by:
    
    canSetAuthentication in interface IAccessMechanics
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    recursive - True if we want to recursively check the item's descendants.
    
    Returns:
    
    True if the user can set the authentication type of the item, False if they can't.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - checkSetAuthentication
```
void checkSetAuthentication(IThingID itemId,
                            IThingID userId,
                            boolean recursive)
                     throws PortalException,
                            PortalAccessException
```
    Throws a PortalAccessException if the specified user cannot set the authentication type of the specified item.
    
    Specified by:
    
    checkSetAuthentication in interface IAccessMechanics
    
    Parameters:
    
    itemId - IURI of item
    
    userId - IThingID of user
    
    recursive - True if we want to recursively check the item's descendants.
    
    Throws:
    
    PortalAccessException - if the user cannot set the authentication type of the item.
    
    PortalException - if the userId is invalid.
  - canCloneRemote
```
boolean canCloneRemote(IThingID destContainerId,
                       IThingID srcItemId,
                       IThingID userId)
                throws PortalException
```
    Returns true if the specified user can clone the specified item.
    
    Parameters:
    
    destContainerId - The IThingID of the destination container.
    
    srcItemId - The IThingID of the item to clone.
    
    userId - The IThingID of the user who wants to clone the item.
    
    Returns:
    
    True if the user can clone the item, False if they can't.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - checkCloneRemote
```
void checkCloneRemote(IThingID destContainerId,
                      IThingID srcItemId,
                      IThingID userId)
               throws PortalException,
                      PortalAccessException
```
    Throws a PortalAccessException if the specified user cannot clone the specified item.
    
    Parameters:
    
    destContainerId - The IThingID of the destination container.
    
    srcItemId - The IThingID of the item to clone.
    
    userId - The IThingID of the user who wants to clone the item.
    
    Throws:
    
    PortalAccessException - if the user cannot clone the item.
    
    PortalException - if the userId is invalid.
  - canDestroy
```
boolean canDestroy(IThingID thingID,
                   IThingID userID)
            throws PortalException
```
    Returns true if user can destroy an item.
    
    Parameters:
    
    thingID - The IThingID of the item to be destroyed.
    
    userID - The IThingID of the user that will destroy the item.
    
    Returns:
    
    True if user can destroy the item, False if they can't.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - checkDestroy
```
void checkDestroy(IThingID thingID,
                  IThingID userID)
           throws PortalException,
                  PortalAccessException
```
    Throws PortalAccessException if the user can not destroy an item.
    
    Parameters:
    
    thingID - The IThingID of the item to be destroyed.
    
    userID - The IThingID of the user that will destroy the item.
    
    Throws:
    
    PortalAccessException - if the user can't destroy the item.
    
    PortalException - if the userId is invalid.
  - fireViewContentEvent
```
void fireViewContentEvent(IThingID itemId,
                          IThingID userId,
                          int status)
                   throws PortalException
```
    Fires a view content event.
    
    Parameters:
    
    itemId - Item whose content was viewed.
    
    userId - User who viewed the content.
    
    status - Status of the event (successful, denied, error).
    
    Throws:
    
    PortalException - if the userId is invalid.
  - fireListContainersEvent
```
void fireListContainersEvent(IThingID itemId,
                             IThingID userId,
                             int status)
                      throws PortalException
```
    Fires a list containers event.
    
    Parameters:
    
    itemId - Item whose containers were listed.
    
    userId - User for whom the containers were listed.
    
    status - Status of the event (successful, denied, error).
    
    Throws:
    
    PortalException - if the userId is invalid.
  - fireListNotesEvent
```
void fireListNotesEvent(IThingID itemId,
                        IThingID userId,
                        int status)
                 throws PortalException
```
    Fires a list notes event.
    
    Parameters:
    
    itemId - Item whose notes were listed.
    
    userId - User for whom the notes were listed.
    
    status - Status of the event (successful, denied, error).
    
    Throws:
    
    PortalException - if the userId is invalid.
  - fireListAccessEvent
```
void fireListAccessEvent(IThingID itemId,
                         IThingID userId,
                         int status)
                  throws PortalException
```
    Fires a list access event.
    
    Parameters:
    
    itemId - Item whose access was listed.
    
    userId - User for whom the access was listed.
    
    status - Status of the event (successful, denied, error).
    
    Throws:
    
    PortalException - if the userId is invalid.
  - fireViewAuthenticationEvent
```
void fireViewAuthenticationEvent(IThingID itemId,
                                 IThingID userId,
                                 int status)
                          throws PortalException
```
    Fires a view authentication event.
    
    Parameters:
    
    itemId - Item whose authentication scheme was viewed.
    
    userId - User who viewed the authentication scheme.
    
    status - Status of the event (successful, denied, error).
    
    Throws:
    
    PortalException - if the userId is invalid.
  - fireUpdateContentEvent
```
void fireUpdateContentEvent(IThingID itemId,
                            IThingID userId,
                            int status,
                            DifferenceMap differences)
                     throws PortalException
```
    Fires an update content event.
    
    Parameters:
    
    itemId - Item whose content was updated.
    
    userId - User who updated the content.
    
    status - Status of the event (successful, denied, error).
    
    differences - Differences between old and new content.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - fireCacheInvalidateEvent
```
void fireCacheInvalidateEvent(IThingID itemId,
                              IThingID userId)
                       throws PortalException
```
    Fires an invalidate cache event.
    
    Parameters:
    
    itemId - Item whose cache you want to invalidate
    
    userId - User doing the invalidation.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - fireInsoEvent
```
void fireInsoEvent(IThingID itemId,
                   IThingID userId)
            throws PortalException
```
    Fires an Inso event. This triggers the conversion of the content into a web-viewable format.
    
    Parameters:
    
    itemId - Item whose content should be converted.
    
    userId - User who triggered the conversion request (typically by updating the content).
    
    Throws:
    
    PortalException - if the userId is invalid.
  - fireUpdatePropertiesEvent
```
void fireUpdatePropertiesEvent(IThingID itemId,
                               IThingID userId,
                               int status,
                               DifferenceMap differences)
                        throws PortalException
```
    Fires an update properties event.
    
    Parameters:
    
    itemId - Item whose properties were updated.
    
    userId - User who updated the properties.
    
    status - Status of the event (successful, denied, error).
    
    differences - Map of properties changed.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - fireDeleteEvent
```
void fireDeleteEvent(IThingID itemId,
                     IThingID containerId,
                     IThingID userId,
                     int status)
              throws PortalException
```
    Fires a delete event.
    
    Parameters:
    
    itemId - Item deleted.
    
    containerId - Container from which item was deleted.
    
    userId - User who deleted the item.
    
    status - Status of the event (successful, denied, error).
    
    Throws:
    
    PortalException - if the userId is invalid.
  - firePurgeEvent
```
void firePurgeEvent(IThingID itemID,
                    IThingID containerID,
                    IThingID userID)
             throws PortalException
```
    Fires thing purge event.
    
    Parameters:
    
    itemID - Item purged.
    
    containerID - Container that item lived in.
    
    userID - User who purged item.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - fireAddNoteEvent
```
void fireAddNoteEvent(IThingID itemId,
                      IThingID userId,
                      int status)
               throws PortalException
```
    Fires an add notes event.
    
    Parameters:
    
    itemId - Item to which notes were added.
    
    userId - User who added the notes.
    
    status - Status of the event (successful, denied, error).
    
    Throws:
    
    PortalException - if the userId is invalid.
  - fireRemoveNoteEvent
```
void fireRemoveNoteEvent(IThingID itemId,
                         IThingID userId,
                         int status)
                  throws PortalException
```
    Fires a remove notes event.
    
    Parameters:
    
    itemId - Item whose notes were removed.
    
    userId - User who removed the notes.
    
    status - Status of the event (successful, denied, error).
    
    Throws:
    
    PortalException - if the userId is invalid.
  - fireSetOwnerEvent
```
void fireSetOwnerEvent(IThingID itemId,
                       IThingID userId,
                       int status,
                       IThingID newOwnerId,
                       IThingID oldOwnerId)
                throws PortalException
```
    Fires a set owner event.
    
    Specified by:
    
    fireSetOwnerEvent in interface IAccessMechanics
    
    Parameters:
    
    itemId - Item whose owner was set.
    
    userId - User who set the owner.
    
    status - Status of the event (successful, denied, error).
    
    newOwnerId - New owner.
    
    oldOwnerId - Old owner.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - fireSetAccessEvent
```
void fireSetAccessEvent(IThingID itemId,
                        IThingID userId,
                        int status,
                        List<? extends IURI> principalIds)
                 throws PortalException
```
    Fires a set access event.
    
    Specified by:
    
    fireSetAccessEvent in interface IAccessMechanics
    
    Parameters:
    
    itemId - Item to whose access list entries were added or modified.
    
    userId - User who set the access.
    
    status - Status of the event (successful, denied, error).
    
    principalIds - List of IURIs whose access was modified.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - fireRemoveAcccesEvent
```
void fireRemoveAcccesEvent(IThingID itemId,
                           IThingID userId,
                           int status,
                           List<? extends IURI> principalIds)
                    throws PortalException
```
    Fires a remove access event.
    
    Specified by:
    
    fireRemoveAcccesEvent in interface IAccessMechanics
    
    Parameters:
    
    itemId - Item to which access list entries were removed.
    
    userId - User who removed the access.
    
    status - Status of the event (successful, denied, error).
    
    principalIds - List of IURIs whose access was removed.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - fireSetAuthenticationEvent
```
void fireSetAuthenticationEvent(IThingID itemId,
                                IThingID userId,
                                int status,
                                String scheme)
                         throws PortalException
```
    Fires a set authentication event.
    
    Specified by:
    
    fireSetAuthenticationEvent in interface IAccessMechanics
    
    Parameters:
    
    itemId - Item whose authentication scheme was set.
    
    userId - User who set the authentication scheme.
    
    status - Status of the event (successful, denied, error).
    
    scheme - Name of the authentication scheme.
    
    Throws:
    
    PortalException - if the userId is invalid.
  - isNormal
```
boolean isNormal(IThingID itemId)
```
    Returns true if the specified item is normal (not deleted/archived/etc).
    
    Parameters:
    
    itemId - Item to check.
    
    Returns:
    
    True if item is normal, False if it is not.
  - isBaseType
```
boolean isBaseType(IThingID itemId)
```
    Returns true if the specified item's xtype is the base for its type. For example a topic whose xtype is 'topic' is of the base xtype for the topic type; a topic whose xtype is 'wm_specialtopic_v1' is not.
    
    Parameters:
    
    itemId - Item to check.
    
    Returns:
    
    True if item's xtype is the base for its type, False if it is not.
  - isContainer
```
boolean isContainer(IThingID itemId)
```
    Returns true if the specified item is a container.
    
    Parameters:
    
    itemId - Item to check.
    
    Returns:
    
    True if the item is a container, False if it isn't.
  - isVersionable
```
boolean isVersionable(IThingID itemId)
```
    Returns true if the specified item is versionable.
    
    Parameters:
    
    itemId - Item to check.
    
    Returns:
    
    True if the item is versionable, False if it isn't.
  - isReference
```
boolean isReference(IView view)
```
    Returns true if the specified view represents a reference to an item, rather than the item itself.
    
    Parameters:
    
    view - View to check.
    
    Returns:
    
    True if the view represents a reference to an item, False if it represents the item itself.
  - getContent
```
InputStream getContent(IThingID itemId)
                throws PortalException
```
    Returns the content stream for the specified item.
    
    Parameters:
    
    itemId - Item for which to get content.
    
    Returns:
    
    Content stream of item, or null if the item contains no content.
    
    Throws:
    
    PortalException
  - getContent
```
InputStream getContent(IThingID itemId,
                       String type)
                throws PortalException
```
    Returns the content stream of a particular type for the specified item.
    
    Parameters:
    
    itemId - Item for which to get content.
    
    type - Content type (ie 'text/html' or 'reference icon').
    
    Returns:
    
    Content stream of item, or null if the item contains no content.
    
    Throws:
    
    PortalException
  - getContentStore
```
IContentStore getContentStore(IThingID itemId)
                       throws PortalException
```
    Returns the content store for the specified item.
    
    Parameters:
    
    itemId - Item for which to get content.
    
    Returns:
    
    Content store of item, or null if the item contains no content.
    
    Throws:
    
    PortalException
  - getContentStore
```
IContentStore getContentStore(IThingID itemId,
                              String type)
                       throws PortalException
```
    Returns the content store of a particular type for the specified item.
    
    Parameters:
    
    itemId - Item for which to get content.
    
    type - Content type (ie 'text/html' or 'reference icon').
    
    Returns:
    
    Content store of item, or null if the item contains no content.
    
    Throws:
    
    PortalException
  - listContainers
```
IListView<IView> listContainers(IThingID itemId)
                         throws PortalException
```
    Returns a list of containers that reference the specified item.
    
    Parameters:
    
    itemId - Item referenced.
    
    Returns:
    
    List of IView items, or an empty list.
    
    Throws:
    
    PortalException
  - listContainers
```
IListView<IView> listContainers(IThingID itemId,
                                IThingID userId)
                         throws PortalException
```
    Returns a list of containers that reference the specified item, filtered for the specified user.
    
    Parameters:
    
    itemId - Item referenced.
    
    userId - User for whom to filter.
    
    Returns:
    
    List of IView items, or an empty list.
    
    Throws:
    
    PortalException
  - listNotes
```
IListView<INote> listNotes(IThingID itemId,
                           IThingID userId)
                    throws PortalException
```
    Returns a list of notes for the comments page, filtered for the specified user.
    
    Parameters:
    
    itemId - Item referenced.
    
    userId - User to filter list for.
    
    Returns:
    
    List of IView items, or an empty list.
    
    Throws:
    
    PortalException
  - addNote
```
void addNote(IThingID itemId,
             IThingID userId,
             String note)
      throws PortalException
```
    Adds a comment to an item.
    
    Parameters:
    
    itemId - Item to add note to.
    
    userId - User adding the note.
    
    note - The note to attach to the item.
    
    Throws:
    
    PortalException
  - removeNote
```
void removeNote(IThingID itemId,
                IThingID userId,
                int noteID)
         throws PortalException
```
    Removes a comment from an item.
    
    Parameters:
    
    itemId - Item to remove note from.
    
    userId - User removing the note.
    
    noteID - The ID of the note to remove.
    
    Throws:
    
    PortalException
  - getAncestors
```
IThingIDList getAncestors(IThingID itemId)
                   throws PortalException
```
    Returns the list of ancestors (ie the parent hierarchy) for the specified item.
    
    Parameters:
    
    itemId - Item.
    
    Returns:
    
    List of ancestors, ordered from root to parent of item, or an empty list if this item has no parent.
    
    Throws:
    
    PortalException
  - listAccess
```
IListView<IView> listAccess(IThingID itemId)
                     throws PortalException
```
    Returns a list of access control entries for the specified item.
    
    Parameters:
    
    itemId - Item whose access entries to list.
    
    Returns:
    
    List of IView items, or an empty list.
    
    Throws:
    
    PortalException
  - listAccess
```
IListView<IView> listAccess(IThingID itemId,
                            IThingID userId)
                     throws PortalException
```
    Returns a list of access control entries for the specified item, filtered for the specified user.
    
    Parameters:
    
    itemId - Item whose access entries should be listed.
    
    userId - User for whom to filter.
    
    Returns:
    
    List of IView items, or an empty list.
    
    Throws:
    
    PortalException
  - isAnonymous
```
boolean isAnonymous(IThingID itemId)
             throws PortalException
```
    Returns true if the specified item allows anonymous access.
    
    Parameters:
    
    itemId - Item to check for anonymous access.
    
    Returns:
    
    True if item allows anonymous access, False if it does not.
    
    Throws:
    
    PortalException
  - getAuthentication
```
String getAuthentication(IThingID itemId)
                  throws PortalException
```
    Returns the authentication scheme name for the specified item.
    
    Parameters:
    
    itemId - Item to retrieve authentication scheme for.
    
    Returns:
    
    the current authentication scheme.
    
    Throws:
    
    PortalException
    
    See Also:
    
    for an example
  - setAuthentication
```
void setAuthentication(IThingID itemId,
                       String authLevel,
                       boolean recursive)
                throws PortalException
```
    Sets the authentication scheme name for the specified item.
    
    Parameters:
    
    itemId - Item to set authentication scheme for.
    
    recursive - whether to set this recursively
    
    Throws:
    
    PortalException
    
    See Also:
    
    IAccessMechanics.AUTH_LEVEL_ANONYMOUS, IAccessMechanics.AUTH_LEVEL_DEFAULT, IAccessMechanics.AUTH_LEVEL_FULL_ACCESS, IAccessMechanics.AUTH_LEVEL_BASIC, IAccessMechanics.AUTH_LEVEL_NTLM
  - getAccess
```
int getAccess(IThingID itemId,
              IThingID userId,
              Map<?,?> capabilities)
       throws PortalException
```
    Returns the bit set representing the access rights the specified user has for the specified item.
    
    Specified by:
    
    getAccess in interface IAccessMechanics
    
    Parameters:
    
    itemId - Item whose access is requested.
    
    userId - User whose access to the item is requested.
    
    capabilities - User's known capabilities for this item. May be null, in which case they'll be looked up from the IContext.SCOPE_REQUEST attributes on the user's IContext.
    
    Returns:
    
    Bit set representing the access rights the user has for the item.
    
    Throws:
    
    PortalException
  - listDependants
```
IListView<IView> listDependants(IThingID itemId)
                         throws PortalException
```
    Lists all items that depend on this item, including this item. For example, when invoked on a workspace this would return the workspace and all the portlets on the workspace.
    
    Parameters:
    
    itemId - Item to check for dependencies.
    
    Returns:
    
    List of IView items, or an empty list.
    
    Throws:
    
    PortalException
  - updateContent
```
void updateContent(IThingID itemId,
                   IThingID userId,
                   InputStream content,
                   String type,
                   boolean insoConvert,
                   String originalPath)
            throws PortalException
```
    Updates the content of the specified item for the specified user. Takes an InputStream as the updated content.
    
    Parameters:
    
    itemId - Item to update.
    
    userId - User updating the content.
    
    content - Updated content.
    
    type - Content type (ie 'text/html' or 'reference icon').
    
    insoConvert - True if the content should be converted to html via inso.
    
    originalPath - Content's original local file path.
    
    Throws:
    
    PortalException
  - updateContent
```
void updateContent(IThingID itemId,
                   IThingID userId,
                   boolean insoConvert,
                   IPortalFileBean portalFileBean,
                   String encoding)
            throws PortalException
```
    Updates the content of the specified item for the specified user. Takes a PortalFileBean as the updated content.
    
    Parameters:
    
    itemId - Item to update.
    
    userId - User updating the content.
    
    insoConvert - True if the content should be converted to HTML via Inso.
    
    portalFileBean - Updated content.
    
    Throws:
    
    PortalException
  - updateProperties
```
DifferenceMap updateProperties(IThingID itemId,
                               IThingID userId,
                               Map<String,? extends Object> properties)
                        throws PortalException
```
    Deprecated.
    
    Throws:
    
    PortalException
    
    See Also:
    
    updateProperties(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, java.util.Map, java.util.Locale)
  - updateProperties
```
DifferenceMap updateProperties(IThingID itemId,
                               IThingID userId,
                               Map<String,? extends Object> properties,
                               Locale locale)
                        throws PortalException
```
    Updates properties
    
    Parameters:
    
    itemId - Item to update.
    
    userId - User updating the properties.
    
    properties - Map of properties to update.
    
    locale - for name and description
    
    Returns:
    
    a map of what properties changed
    
    Throws:
    
    PortalException
  - delete
```
void delete(IThingID itemId)
     throws PortalException
```
    Deletes the specified item, and if the item is a container, the container's descendants.
    
    Parameters:
    
    itemId - Item to delete.
    
    Throws:
    
    PortalException
  - destroy
```
void destroy(IThingID itemID)
      throws PortalException
```
    Destroys the specified item and all of its descendants.
    
    Parameters:
    
    itemID - Item to destroy.
    
    Throws:
    
    PortalException
  - prepareForDeletion
```
void prepareForDeletion(IThingID itemId)
                 throws PortalException
```
    Prepares the specified item to be deleted as part of a recursive deletion operation initiated on one of the item's ancestors (or the item itself).
    
    Parameters:
    
    itemId - The item to be deleted.
    
    Throws:
    
    PortalException
  - create
```
IThingID create(IThingID containerId,
                IThingID userId,
                int xtype,
                Map<String,? extends Object> properties)
         throws PortalException
```
    Deprecated.
    
    Throws:
    
    PortalException
    
    See Also:
    
    create(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, int, java.util.Map, java.util.Locale)
  - create
```
IThingID create(IThingID containerId,
                IThingID userId,
                int xtype,
                Map<String,? extends Object> properties,
                Locale locale)
         throws PortalException
```
    Creates a new item of the specified xtype in the specified container. Typically, this method is invoked only by IContainerMechanics.createChild(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, int, java.util.Map<java.lang.String, ? extends java.lang.Object>).
    
    Parameters:
    
    containerId - Container in which to create the new item.
    
    userId - User for whom the item will be created.
    
    xtype - Item type to create.
    
    properties - New item's properties. May not be null.
    
    locale - for name and description properties
    
    Returns:
    
    IThingID of new item
    
    Throws:
    
    PortalException
  - copy
```
IThingID copy(IThingID containerId,
              IThingID userId,
              IThingID childId)
       throws PortalException
```
    Creates a new copy of the specified child in the specified container. Typically, this method is invoked only by IContainerMechanics.copyChild(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID).
    
    Parameters:
    
    containerId - Container in which to create copy.
    
    userId - User for whom copy will be made.
    
    childId - Item to copy.
    
    Returns:
    
    IThingID of new item
    
    Throws:
    
    PortalException
  - move
```
void move(IThingID containerId,
          IThingID childId)
   throws PortalException
```
    Moves the specified item into the specified container. Typically, this method is invoked only by IContainerMechanics.moveChild(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID).
    
    Parameters:
    
    containerId - Container into which to move the item.
    
    childId - Item to move.
    
    Throws:
    
    PortalException
  - move
```
void move(IThingID containerId,
          IThingID childId,
          String newName)
   throws PortalException
```
    Moves and renames the specified item into the specified container. Typically, this method is invoked only by IContainerMechanics.moveChild(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID).
    
    Parameters:
    
    containerId - Container into which to move the item.
    
    childId - Item to move.
    
    newName - the new name to assign the moved item
    
    Throws:
    
    PortalException
  - addReference
```
void addReference(IThingID containerId,
                  IThingID childId)
           throws PortalException
```
    Adds a reference to the specified item into the specified container. Typically, this method is invoked only by IContainerMechanics.addReferenceToChild(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID).
    
    Parameters:
    
    containerId - Container in which to add a reference to the item.
    
    childId - Item to add a reference to.
    
    Throws:
    
    PortalException
  - removeReference
```
void removeReference(IThingID containerId,
                     IThingID childId)
              throws PortalException
```
    Removes the reference to the specified item from the specified container. Typically, this method is invoked only by IContainerMechanics.removeReferenceToChild(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID).
    
    Parameters:
    
    containerId - Container from which to remove the reference.
    
    childId - Item whose reference is to be removed.
    
    Throws:
    
    PortalException
  - addRelation
```
void addRelation(IThingID containerId,
                 IThingID childId,
                 String relType)
          throws PortalException
```
    Add relation between containerID and childID using specified relType
    
    Parameters:
    
    containerId - Container from which to add relationship
    
    childId - Child to be related to container
    
    relType - relationship type between Container and child
    
    Throws:
    
    PortalException
  - removeRelation
```
void removeRelation(IThingID containerId,
                    IThingID childId,
                    String relType)
             throws PortalException
```
    Counterpart to addRelation method. It removes relationship between container and child
    
    Parameters:
    
    containerId - Container from which to remove relationship
    
    childId - Child which to be removed
    
    relType - relationship type between Container and child
    
    Throws:
    
    PortalException
  - listRelatedChildren
```
IThingIDList listRelatedChildren(IThingID containerID,
                                 String relType,
                                 int start,
                                 int end)
                          throws PortalException
```
    Returns list of thing IDs of all related things to the specified container
    
    Parameters:
    
    containerID - Container which we want to retrieve list of related things
    
    relType - relationship type.
    
    start - start index for the list. Start from 0.
    
    end - End index for the list. Starts from 0. -1 will return all items
    
    Returns:
    
    list of ThingIDs (could be empty if there are no related things)
    
    Throws:
    
    PortalException
  - listRelatedContainers
```
IThingIDList listRelatedContainers(IThingID childID,
                                   String relType,
                                   int start,
                                   int end)
                            throws PortalException
```
    Returns list of thing IDs of containers that contain specified child with relationship type
    
    Parameters:
    
    childID - child from which we want to return all containers
    
    relType - relationship type
    
    start - start index for the list. Starts from 0.
    
    end - End index for the list. Starts from 0. -1 will return all items
    
    Returns:
    
    list of ThingIDs (could be empty if there are no related things)
    
    Throws:
    
    PortalException
  - getPrimaryRelatedChild
```
IThingID getPrimaryRelatedChild(IThingID containerID,
                                String relType)
                         throws PortalException
```
    Returns first normal related child of specified relationship type.
    
    Parameters:
    
    containerID - Source of relationship.
    
    relType - Relationship type.
    
    Returns:
    
    First normal related child or null.
    
    Throws:
    
    PortalException
  - getPrimaryRelatedContainer
```
IThingID getPrimaryRelatedContainer(IThingID childID,
                                    String relType)
                             throws PortalException
```
    Returns first normal related container of specified relationship type.
    
    Parameters:
    
    childID - Target of relationship.
    
    relType - Relationship type.
    
    Returns:
    
    First normal related container or null.
    
    Throws:
    
    PortalException
  - setOwner
```
void setOwner(IThingID itemId,
              IThingID ownerId)
       throws PortalException
```
    Sets the owner of the specified item.
    
    Parameters:
    
    itemId - Item whose ownership will be changed.
    
    ownerId - New owner.
    
    Throws:
    
    PortalException
  - doAfterInstall
```
void doAfterInstall(IThingID itemID)
             throws PortalException
```
    Actions to perform after installation.
    
    Parameters:
    
    itemID -
    
    Throws:
    
    PortalException
  - doBeforeUpgrade
```
void doBeforeUpgrade(IThingID itemID)
              throws PortalException
```
    Actions to perform before upgrade.
    
    Parameters:
    
    itemID -
    
    Throws:
    
    PortalException
  - doAfterUpgrade
```
void doAfterUpgrade(IThingID itemID)
             throws PortalException
```
    Actions to perform after upgrade.
    
    Parameters:
    
    itemID -
    
    Throws:
    
    PortalException
  - canUninstall
```
boolean canUninstall(IThingID itemID)
              throws PortalException
```
    Check to see if item can be uninstalled.
    
    Parameters:
    
    itemID -
    
    Returns:
    
    True if item can be uninstalled, False if it cannot.
    
    Throws:
    
    PortalException
  - checkUninstall
```
void checkUninstall(IThingID itemID)
             throws PortalException
```
    Check to see if an item can be uninstalled.
    
    Parameters:
    
    itemID - Item to check.
    
    Throws:
    
    PortalException - if the item can't be uninstalled.
  - doBeforeUninstall
```
void doBeforeUninstall(IThingID itemID)
                throws PortalException
```
    Actions to be performed before an uninstall.
    
    Parameters:
    
    itemID -
    
    Throws:
    
    PortalException
  - isWorkflowEnabled
```
@Deprecated
boolean isWorkflowEnabled(IThingID userID,
                                      IThingID containerId)
                               throws PortalException
```
    Deprecated. not used anymore
    
    Returns true if there is a workflow associated with this container.
    
    Parameters:
    
    userID - user ID that performs operation
    
    containerId - container to check for workflow
    
    Returns:
    
    True if there is workflow associated with this container.
    
    Throws:
    
    PortalException
  - getTimeToLive
```
@Deprecated
long getTimeToLive()
                        throws PortalException
```
    Deprecated. not used in 8.x+
    
    Gets the time to live for a deleted object.
    
    Returns:
    
    Time To Live (in milliseconds)
    
    Throws:
    
    PortalException
    
    See Also:
    
    IThing.delete(long, com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID)
  - setTimeToLive
```
@Deprecated
void setTimeToLive(long timeToLive)
                        throws PortalException
```
    Deprecated. not used in 8.x+
    
    Sets the time to live for a deleted object.
    
    Parameters:
    
    timeToLive - Time to Live (in milliseconds)
    
    Throws:
    
    PortalException
    
    See Also:
    
    IThing.delete(long, com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID)
  - undeleteAllUndestroyed
```
IThingIDList undeleteAllUndestroyed()
                             throws PortalException
```
    Attempts to undelete all things that are in the "undestroyed" state. This state is set for a thing whenever it fails to be purged from database, usually happens because of some untracked FK's. Then manual intervention is needed in that case better to simply undelete a thing
    
    Throws:
    
    MetaException
    
    PortalException
  - getDependencyList
```
IThingIDList getDependencyList(IThingID thingID,
                               IThingIDList mergeList)
                        throws PortalException
```
    Get the dependency list for this item. For containers this is recursive, for workspaces this should include all of the portlets on the page. For portlets, it should include all of the things that it relies upon.
    
    Parameters:
    
    thingID - Item for which to find dependencies.
    
    mergeList - A continuing list of id's to merge with. May be null.
    
    Returns:
    
    An IThingIDList of IThingIDs that this item depends on.
    
    Throws:
    
    PortalException
  - cloneRemote
```
IThingID cloneRemote(IThingID destContainerId,
                     IThingID srcItemId,
                     IThingID userId,
                     Map<String,?> maps)
              throws PortalException
```
    Clones remote item in the specified destination container. Basic implementation prepares properties for an item to be created and then calls IContainerMechanics.createChild(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, int, java.util.Map<java.lang.String, ? extends java.lang.Object>).
    
    Parameters:
    
    destContainerId - Container in which to create item.
    
    srcItemId - Remote item to be cloned.
    
    userId - Local User, which creates an instance.
    
    maps - Various parameters which give the mechanics more details on how the item should be cloned. Can be null.
    
    Returns:
    
    Cloned item.
    
    Throws:
    
    PortalException
  - canDoTitlebarAction
```
boolean canDoTitlebarAction(IThingID thingID,
                            String titlebarAction)
                     throws PortalException
```
    Titlebar implementation may an object if it supports certain titlebar defined action
    
    Parameters:
    
    thingID - thing ID of an object
    
    titlebarAction - defined action. See TITLEBAR_ACTION_XXX constants defined in this class
    
    Returns:
    
    whether the particular action is permitted for an object
    
    Throws:
    
    PortalException
  - canVerb
```
boolean canVerb(IURI itemURI,
                IURI userURI,
                String verb,
                Object param)
         throws PortalException
```
    Checks if given user could perform given operation (verb) on given object
    
    Throws:
    
    PortalException

Interface IBasicMechanics

Field Summary

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

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

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

Method Summary

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

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

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

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

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

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

Field Detail

TITLEBAR_ACTION_SHOW_NORMAL

TITLEBAR_ACTION_SHOW_MINIMIZED

TITLEBAR_ACTION_SHOW_MAXIMIZED

TITLEBAR_ACTION_SHOW_ADD_TO_HOME

TITLEBAR_ACTION_SHOW_DISPLAY_OPTIONS

PROP_FILE_ENCODING

PROP_CUSTOM_FILE_ENCODING

Method Detail

canViewContent

checkViewContent

canListContainers

checkListContainers

canListNotes

checkListNotes

canListAccess

checkListAccess

canViewAuthentication

checkViewAuthentication

canCreate

checkCreate

canUpdateContent

checkUpdateContent

canUpdateProperties

checkUpdateProperties

canDelete

checkDelete

canAddNote

checkAddNote

canRemoveNote

checkRemoveNote

canSetOwner

checkSetOwner

canSetAccess

checkSetAccess

canRemoveAccess

checkRemoveAccess

canSetAuthentication

checkSetAuthentication

canCloneRemote

checkCloneRemote

canDestroy

checkDestroy

fireViewContentEvent

fireListContainersEvent

fireListNotesEvent

fireListAccessEvent

fireViewAuthenticationEvent

fireUpdateContentEvent

fireCacheInvalidateEvent

fireInsoEvent

fireUpdatePropertiesEvent

fireDeleteEvent

firePurgeEvent

fireAddNoteEvent

fireRemoveNoteEvent

fireSetOwnerEvent

fireSetAccessEvent

fireRemoveAcccesEvent

fireSetAuthenticationEvent

isNormal

isBaseType

isContainer

isVersionable

isReference

getContent

getContent

getContentStore