public interface IVersionableMechanics extends IBasicMechanics
Also, defines methods to check access and to fire events related to the versioning operations
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
CONTENT_FORMAT_EMAIL, CONTENT_FORMAT_EMAIL_DIGEST, CONTENT_FORMAT_PORTAL_INBOX, CONTENT_FORMAT_PORTAL_INBOX_DIGEST, HEADER_FROM, HEADER_SUBJECT, HEADER_TO
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
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
Modifier and Type | Method and Description |
---|---|
IThingID |
addToVersioning(IThingID itemId,
IThingID userId)
Adds the specified item to versioning.
|
boolean |
canAddToVersioning(IThingID itemId,
IThingID userId)
Checks whether or not the specified user can add the specified item into the versioning.
|
boolean |
canCheckIn(IThingID itemId,
IThingID userId)
Checks whether or not the specified user can check the specified item in.
|
boolean |
canCheckOut(IThingID itemId,
IThingID userId)
Check if the specified user can check out the specified item.
|
boolean |
canListVersions(IThingID itemId,
IThingID userId,
Map<?,?> capabilities)
Check if the specified user can list versions of the specified item.
|
boolean |
canPublishVersion(IThingID itemId,
IThingID userId)
Checks whether or not the specified user can publish a version of the specified item.
|
boolean |
canRemoveFromVersioning(IThingID itemId,
IThingID userId)
Checks whether or not the specified user can remove the specified item from the versioning.
|
boolean |
canSetCurrentVersion(IThingID itemId,
IThingID userId,
String version)
Checks whether or not the specified user can set the specified version as the most current one.
|
boolean |
canUndoCheckOut(IThingID itemId,
IThingID userId)
Checks whether or not the specified user can uncheck the specified item.
|
boolean |
canViewVersion(IThingID itemId,
IThingID userId,
Map<?,?> capabilities,
String version)
Checks if the specified user can view the specified version.
|
void |
checkAddToVersioning(IThingID itemId,
IThingID userId)
The same as
canAddToVersioning(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID) but throws an exception. |
void |
checkCheckIn(IThingID itemId,
IThingID userId)
The same as
canCheckIn(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID) but throws an exception. |
void |
checkCheckOut(IThingID itemId,
IThingID userId)
The same as
canCheckOut(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID) but throws an exception. |
void |
checkIn(IThingID itemId,
IThingID userId,
Object dataToBeCheckedIn,
String sComment,
String encoding)
Checks in the specified item.
|
void |
checkListVersions(IThingID itemId,
IThingID userId,
Map<?,?> capabilities)
The same as
canListVersions(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, java.util.Map<?, ?>) but throws an exception. |
void |
checkOut(IThingID itemId,
IThingID userId)
Checks out the specified item.
|
void |
checkPublishVersion(IThingID itemId,
IThingID userId)
The same as
canPublishVersion(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID) but throws an exception. |
void |
checkRemoveFromVersioning(IThingID itemId,
IThingID userId)
The same as
canRemoveFromVersioning(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID) but throws an exception. |
void |
checkSetCurrentVersion(IThingID itemId,
IThingID userId,
String version)
The same as
canSetCurrentVersion(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, java.lang.String) but throws an exception. |
void |
checkUndoCheckOut(IThingID itemId,
IThingID userId)
The same as
canUndoCheckOut(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID) but throws an exception. |
void |
checkViewVersion(IThingID itemId,
IThingID userId,
Map<?,?> capabilities,
String version)
|
void |
fireAddToVersioningEvent(IThingID itemId,
IThingID userId,
int status)
Fires an event to indicate that the specified item is added into the versioning.
|
void |
fireCheckInEvent(IThingID itemId,
IThingID userId,
int status)
Fires an event to indicate that the specified item is checked in.
|
void |
fireCheckOutEvent(IThingID itemId,
IThingID userId,
int status)
Fires an event to indicate that the specified item is checked out.
|
void |
fireListVersionsEvent(IThingID itemId,
IThingID userId,
int status)
Fires an event to indicate that versions of the specified item is listed.
|
void |
firePublishVersionEvent(IThingID srcItemId,
IThingID userId,
int status,
int version,
IThingID dstContainerId,
IThingID dstItemId)
Fires an event to indicate that the specified version is published.
|
void |
fireRemoveFromVersioningEvent(IThingID itemId,
IThingID userId,
int status)
Fires an event to indicate that the specified item is removed from the versioning.
|
void |
fireSetCurrentVersionEvent(IThingID itemId,
IThingID userId,
int status,
String version)
Fires an event to indicate that the specified version of the specified item is set as the current one.
|
void |
fireUndoCheckOutEvent(IThingID itemId,
IThingID userId,
int status)
Fires an event to indicate that the specified item is unchecked.
|
void |
fireViewVersionEvent(IThingID itemId,
IThingID userId,
int status,
String version)
Fires an event when a version of the specified item is viewed.
|
IThingID |
getCheckedOutBy(IThingID itemId)
Returns the user ID who has the specified item checked out,
or null if the item is not checked out.
|
IVersion |
getVersion(IThingID itemId,
String sVersionId)
Returns the version given by its id.
|
boolean |
isCheckedOut(IThingID itemId)
Checks whether or not the specified item is checked out.
|
boolean |
isVersioned(IThingID itemId)
Checks whether or not the specified item is versioned.
|
IListView<IView> |
listVersions(IThingID itemId)
Returns a list of
IView of the specified item. |
IThingID |
publishVersion(IThingID containerId,
IThingID userId,
IThingID itemId,
String sVersionId)
Publishes a copy of the specified version of the specified item into the specified container.
|
void |
removeFromVersioning(IThingID itemId,
IThingID userId)
Removes the specified item from the versioning.
|
void |
setCurrentVersion(IThingID itemId,
IThingID userId,
String sVersionId)
Sets the specified version of the specified item as the current version.
|
void |
undoCheckOut(IThingID itemId,
IThingID userId)
Undoes the check out of the specified item.
|
IView |
viewVersion(IThingID itemId,
String sVersionId)
Returns a view of the version given by its id.
|
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
canCopyToClipboard, canCutToClipboard, checkCopyToClipboard, checkCutToClipboard, copyToClipboard, cutToClipboard, getClipboard, getClipboardInfo, newClipboardItem
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
canView, checkView, createPagingCookie, fireViewEvent, getCss, getCss, getDefaultLinkType, getFormattedProperty, getHierachicalUri, getIcon, getIcon, getLink, getLink, getListProperty, getListPropertyHTML, getListPropertyJS, isEnabled, view, view
getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider
init, shutdown
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
boolean canViewVersion(IThingID itemId, IThingID userId, Map<?,?> capabilities, String version) throws PortalException
The user has to have IAccessRight.READ
to view a version.
itemId
- The item, whose version is to be viewed.userId
- The user, whose rights to be checked.capabilities
- The capabilities of the user.version
- The ID of the version to be viewed.PortalException
- if any error occuresvoid checkViewVersion(IThingID itemId, IThingID userId, Map<?,?> capabilities, String version) throws PortalException, PortalAccessException
canViewVersion(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, java.util.Map<?, ?>, java.lang.String)
but throws an exception.itemId
- The item, whose version is to be viewed.userId
- The user, whose rights to be checked.capabilities
- The capabilities of the user.version
- The ID of the version to be viewed.PortalException
- if any error occursPortalAccessException
- if the user does not have right to view the version.canViewVersion(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, java.util.Map<?, ?>, java.lang.String)
boolean canListVersions(IThingID itemId, IThingID userId, Map<?,?> capabilities) throws PortalException
The user has to have IAccessRight.READ
to list versions.
itemId
- The item, whose versions are to be listed.userId
- The user, whose rights to be checked.capabilities
- The capabilities of the user.PortalException
- if any error occursvoid checkListVersions(IThingID itemId, IThingID userId, Map<?,?> capabilities) throws PortalException, PortalAccessException
canListVersions(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, java.util.Map<?, ?>)
but throws an exception.itemId
- The item, whose versions are to be listed.userId
- The user, whose rights to be checked.capabilities
- The capabilities of the user.PortalAccessException
- if the specified user can not list the versions of the specified item.PortalException
- if any error occurscanListVersions(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, java.util.Map<?, ?>)
boolean canAddToVersioning(IThingID itemId, IThingID userId) throws PortalException
The user has to have IAccessRight.MODIFY
to add the item into the versioning.
itemId
- The item is to be versioned.userId
- The user, whose rights to be checked.PortalException
- if any error occursvoid checkAddToVersioning(IThingID itemId, IThingID userId) throws PortalException, PortalAccessException
canAddToVersioning(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID)
but throws an exception.itemId
- The item is to be versioned.userId
- The user, whose rights to be checked.PortalException
- if any error occursPortalAccessException
- if the specified user cannot add the specified item into the versioningcanAddToVersioning(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID)
boolean canRemoveFromVersioning(IThingID itemId, IThingID userId) throws PortalException
The user has to have IAccessRight.DELETE
to remove the item from the versioning.
itemId
- The item is to be removed from the versioning.userId
- The user, whose rights to be checked.PortalException
- if any error occursvoid checkRemoveFromVersioning(IThingID itemId, IThingID userId) throws PortalException, PortalAccessException
canRemoveFromVersioning(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID)
but throws an exception.itemId
- The item is to be removed from the versioning.userId
- The user, whose rights to be checked.PortalException
- if any error occursPortalAccessException
- if the specified user can not remove the specified item from the versioning.canRemoveFromVersioning(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID)
boolean canSetCurrentVersion(IThingID itemId, IThingID userId, String version) throws PortalException
The user has to have IAccessRight.MODIFY
.
itemId
- The item, for which to set current version.userId
- The user, whose rights to be checked.version
- ID of the version to be set as the current one.PortalException
- if any error occursvoid checkSetCurrentVersion(IThingID itemId, IThingID userId, String version) throws PortalException, PortalAccessException
canSetCurrentVersion(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, java.lang.String)
but throws an exception.itemId
- The item, for which to set current version.userId
- The user, whose rights to be checked.version
- ID of the version to be set as the current one.PortalException
- if any error occursPortalAccessException
- if the specified user cannot set the current version of the specified item.canSetCurrentVersion(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, java.lang.String)
boolean canPublishVersion(IThingID itemId, IThingID userId) throws PortalException
itemId
- The item, whose version to publish.userId
- The user, whose rights to be checked.PortalException
- if any error occursvoid checkPublishVersion(IThingID itemId, IThingID userId) throws PortalException, PortalAccessException
canPublishVersion(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID)
but throws an exception.itemId
- The item, whose version to publish.userId
- The user, whose rights to be checked.PortalException
- if any error occursPortalAccessException
- if the specified user cannot publish a version the specified item.canPublishVersion(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID)
boolean canCheckOut(IThingID itemId, IThingID userId) throws PortalException
The specified item should not be checked out by another user.
The user has to have IAccessRight.MODIFY
.
itemId
- The item is to be checked out.userId
- The user, whose rights to be checked.PortalException
- if any error occursvoid checkCheckOut(IThingID itemId, IThingID userId) throws PortalException, PortalAccessException
canCheckOut(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID)
but throws an exception.itemId
- The item is to be checked out.userId
- The user, whose rights to be checked.PortalException
- if any error occursPortalAccessException
- if the specified user can not check out the specified item.canCheckOut(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID)
boolean canCheckIn(IThingID itemId, IThingID userId) throws PortalException
The specified item has to be checked out by the specified user.
itemId
- The item is to be checked in.userId
- The user, whose rights to be checked.PortalException
- if any error occursvoid checkCheckIn(IThingID itemId, IThingID userId) throws PortalException, PortalAccessException
canCheckIn(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID)
but throws an exception.itemId
- The item is to be checked in.userId
- The user, whose rights to be checked.PortalException
- if any error occursPortalAccessException
- if the specified user can not check in the specified itemboolean canUndoCheckOut(IThingID itemId, IThingID userId) throws PortalException
itemId
- The item is to be unchecked.userId
- The user, whose rights to be checked.PortalException
- if any error occursvoid checkUndoCheckOut(IThingID itemId, IThingID userId) throws PortalException, PortalAccessException
canUndoCheckOut(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID)
but throws an exception.itemId
- The item is to be unchecked.userId
- The user, whose rights to be checked.PortalException
- if any error occursPortalAccessException
- if the specified user can not uncheck out the specified itemcanUndoCheckOut(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID)
void fireViewVersionEvent(IThingID itemId, IThingID userId, int status, String version) throws PortalException
IBasicMechanics.fireUpdatePropertiesEvent(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, int, com.webmethods.rtl.util.obj.DifferenceMap)
.itemId
- The item whose version is viewed.userId
- The user who views the version.status
- The status of the event (sucessful, denied, error).version
- ID of the version viewed.PortalException
- if any error occursIPortalEvent
void fireListVersionsEvent(IThingID itemId, IThingID userId, int status) throws PortalException
IBasicMechanics.fireUpdatePropertiesEvent(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, int, com.webmethods.rtl.util.obj.DifferenceMap)
.itemId
- The item whose versions were listed.userId
- The user who listed the versions.status
- The status of the event (sucessful, denied, error).PortalException
- if any error occursIPortalEvent
void fireAddToVersioningEvent(IThingID itemId, IThingID userId, int status) throws PortalException
IBasicMechanics.fireUpdatePropertiesEvent(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, int, com.webmethods.rtl.util.obj.DifferenceMap)
.itemId
- The item was added into the versioning.userId
- The user who added the item into the versioning.status
- The status of the event (sucessful, denied, error).PortalException
- if any error occursIPortalEvent
void fireRemoveFromVersioningEvent(IThingID itemId, IThingID userId, int status) throws PortalException
IBasicMechanics.fireUpdatePropertiesEvent(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, int, com.webmethods.rtl.util.obj.DifferenceMap)
.itemId
- The item was removed from versioning.userId
- The user who removed the item from versioning.status
- The status of the event (sucessful, denied, error).PortalException
- if any error occursIPortalEvent
void fireSetCurrentVersionEvent(IThingID itemId, IThingID userId, int status, String version) throws PortalException
IBasicMechanics.fireUpdatePropertiesEvent(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, int, com.webmethods.rtl.util.obj.DifferenceMap)
.itemId
- The item whose version was set as the current one.userId
- The user who set the current version.status
- The status of the event (sucessful, denied, error).version
- ID of the version was set as the curent one.PortalException
- if any error occursIPortalEvent
void firePublishVersionEvent(IThingID srcItemId, IThingID userId, int status, int version, IThingID dstContainerId, IThingID dstItemId) throws PortalException
IBasicMechanics.fireUpdatePropertiesEvent(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, int, com.webmethods.rtl.util.obj.DifferenceMap)
.srcItemId
- The item whose version was published.userId
- The user who published the version.status
- The status of the event (sucessful, denied, error).version
- ID of the published version.dstContainerId
- The container into which the version was published.dstItemId
- The newly published item.PortalException
- if any error occursIPortalEvent
void fireCheckOutEvent(IThingID itemId, IThingID userId, int status) throws PortalException
IBasicMechanics.fireUpdatePropertiesEvent(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, int, com.webmethods.rtl.util.obj.DifferenceMap)
.itemId
- The item was checked out.userId
- The user who checked out the item.status
- Status of the event (sucessful, denied, error).PortalException
- if any error occursIPortalEvent
void fireCheckInEvent(IThingID itemId, IThingID userId, int status) throws PortalException
IBasicMechanics.fireUpdatePropertiesEvent(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, int, com.webmethods.rtl.util.obj.DifferenceMap)
.itemId
- The item was checked in.userId
- The user who checked in the item.status
- The status of the event (sucessful, denied, error).PortalException
- if any error occursIPortalEvent
void fireUndoCheckOutEvent(IThingID itemId, IThingID userId, int status) throws PortalException
IBasicMechanics.fireUpdatePropertiesEvent(com.webmethods.portal.service.meta2.thing.IThingID, com.webmethods.portal.service.meta2.thing.IThingID, int, com.webmethods.rtl.util.obj.DifferenceMap)
.itemId
- The item was checked out.userId
- The user who unchecked out of the item.status
- Status of the event (sucessful, denied, error).PortalException
- if any error occursIPortalEvent
boolean isVersioned(IThingID itemId) throws PortalException
itemId
- The item is to be tested.PortalException
- if any error occursboolean isCheckedOut(IThingID itemId) throws PortalException
itemId
- The item is to be tested.PortalException
- if any error occursIThingID getCheckedOutBy(IThingID itemId) throws PortalException
itemId
- The item is to be tested.PortalException
- if any error occursIVersion getVersion(IThingID itemId, String sVersionId) throws PortalException
itemId
- item whose version is to be returnedsVersionId
- ID the version to be returnedPortalException
- if the version could not be found or any error occursIView viewVersion(IThingID itemId, String sVersionId) throws PortalException
itemId
- The item whose version is to be viewedsVersionId
- ID the version to be returnedPortalException
- if the version could not be found or any error occursIListView<IView> listVersions(IThingID itemId) throws PortalException
IView
of the specified item. The versions are sorted in ascending order.itemId
- The item for which to list versions.IView
items, or an empty list.PortalException
- if any error occursIThingID addToVersioning(IThingID itemId, IThingID userId) throws PortalException
itemId
- The item is to be added into the versioning.userId
- The user adding the item.PortalException
- if any error occursvoid removeFromVersioning(IThingID itemId, IThingID userId) throws PortalException
itemId
- The item is to be removed from the versioning.userId
- The user removing the item.PortalException
- if any error occursvoid setCurrentVersion(IThingID itemId, IThingID userId, String sVersionId) throws PortalException
itemId
- The item for which to set the current version.userId
- The user setting the current version.sVersionId
- ID of the version to be set as the current one (could not be latest version).PortalException
- if any error occursIThingID publishVersion(IThingID containerId, IThingID userId, IThingID itemId, String sVersionId) throws PortalException
getVersion(com.webmethods.portal.service.meta2.thing.IThingID, java.lang.String)
is
used. It returns the version and then it is passed in the publish process.containerId
- The container into which to publish the new item.userId
- The user publishing the version.itemId
- The item whose version to publish.sVersionId
- ID of the version to be published.PortalException
- if any error occursvoid checkOut(IThingID itemId, IThingID userId) throws PortalException
itemId
- The item to check out.userId
- The user checking out the item.PortalException
- if any error occursvoid checkIn(IThingID itemId, IThingID userId, Object dataToBeCheckedIn, String sComment, String encoding) throws PortalException
itemId
- The item to be checked in.userId
- The user checking in the item.dataToBeCheckedIn
- The data to be checked in. That is strongly depends on type of the item.
Since the versioning system supports just @com.webmethods.portal.service.meta2.storage.IContent
this parameter is com.webmethods.rtl.util.obj.PortalFileBean
sComment
- The comment to label the version being checked in.PortalException
- if any error occursvoid undoCheckOut(IThingID itemId, IThingID userId) throws PortalException
itemId
- The item for which to undo the check out.userId
- The user undoing the check out.PortalException
- if any error occurs