Class UserEntitiesTransform
- java.lang.Object
-
- com.microstrategy.web.transform.AbstractTransform
-
- com.microstrategy.web.transform.AbstractLayoutTransform
-
- com.microstrategy.web.app.transforms.AbstractAppTransform
-
- com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
-
- com.microstrategy.web.app.transforms.UserEntitiesTransform
-
- All Implemented Interfaces:
AppTransform,LayoutTransform,Transform
- Direct Known Subclasses:
UserGroupTransform
public class UserEntitiesTransform extends AbstractObjectInfoListTransform
- Since:
- MicroStrategy Web 9.0.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classUserEntitiesTransform.ContextExtendsAbstractAppTransform.Contextby providing a link to the currentWebObjectInfo.
-
Field Summary
-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
FP_INCREMENTAL_FETCH_NAV_TYPE, FP_INCREMENTAL_FETCH_PAGE_BLOCK, imgBlank, incrementalFetchNavigationType, incrementalFetchPageBlock
-
Fields inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
_bean, _componentBlock, _cssPrefix, _imgBlank, _imgWait, _selfOutput, _subOutput, appliesTo, CLASS_INPUT, CLASS_MESSAGE, contextMenus, cssFile, cssPrefix, debugErrorFlags, debugFlags, dragMode, extraInput, extraUrl, FP_APPLIES_TO, FP_CONTEXT_MENUS, FP_CSS_ERROR_MESSAGE, FP_CSS_ERROR_TITLE, FP_CSS_FILE, FP_CSS_PREFIX, FP_DEBUG_ERROR_FLAGS, FP_DEBUG_FLAGS, FP_DRAG_MODE, FP_EXTRA_INPUT, FP_EXTRA_URL, FP_HEIGHT, FP_IFRAME_ENABLED, FP_IMG_WAIT, FP_INITIAL_INDENT, FP_ORIENTATION, FP_ORIENTATIONS_ALLOWED, FP_PARTIAL_IFRAME_UPDATE, FP_PROCESSING_BUTTONS_FLAGS, FP_PROCESSING_INFO_FLAGS, FP_RESIZE_LEVEL, FP_SCRIPT_CLASS, FP_TYPE, FP_USE_DHTML, FP_WIDTH, globalCssErrorMessage, globalCssErrorTitle, height, iframeEnabled, imgWait, indent, initialIndent, isDHTML, orientation, orientationsAllowed, partialIframeUpdate, PROCESSING_BUTTONS_ALL, PROCESSING_BUTTONS_CANCEL, PROCESSING_BUTTONS_HISTORY_LIST, PROCESSING_BUTTONS_REFRESH, PROCESSING_BUTTONS_VIEW_DETAILS, PROCESSING_INFO_ALL, PROCESSING_INFO_DESCRIPTION, PROCESSING_INFO_LAST_UPDATE, PROCESSING_INFO_NAME, PROCESSING_INFO_NONE, PROCESSING_INFO_STATUS, processingButtonsFlags, processingInfoFlags, RESIZE_ALL, RESIZE_HORIZONTAL, RESIZE_NONE, RESIZE_VERTICAL, resizeLevel, scriptClass, scriptEndTagEncoder, type, useDHTML, width
-
-
Constructor Summary
Constructors Constructor Description UserEntitiesTransform()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleancanCreate()booleancanCreateGroup()booleancanCreateUser()booleancanDelete(WebObjectInfo object)booleancanEdit(WebObjectInfo object)protected intgetBlockPosition()protected intgetBlockSize()protected intgetChildCount()protected TransformContextgetContext()Returns the instance of TransformContext with context information for this Transform.protected ContextMenugetContextMenu(WebObjectInfo object)java.util.MapgetContextMenuAttributes(WebObjectInfo object)WebEventgetDeleteEvent(WebObjectInfo object)java.lang.StringgetDescription()Returns a textual description of the transform.WebEventgetEditEvent(WebObjectInfo object)WebEventgetEvent(WebObjectInfo object)Generate the event that allows users to request actions on a given object.intgetGoToArgument()WebEventgetGoToEvent()WebEventgetNewGroupEvent()WebEventgetNewUserEvent()java.lang.StringgetObjectAbbreviation(WebObjectInfo object)Utility method for obtaining the abbreviation of the object being analyzedjava.util.ListgetSortedList()java.lang.ClassgetSupportedBeanType()Returns the supported bean type.protected UserEntitiesBeangetUserEntitiesBean()voidinitializeTransform(Transformable data)This method initialize the private and protected fields of the transform, such as width and height.booleanisEmptyList()booleanisObjectNotNull(WebObjectInfo object)Convenience method to check object is Null.protected TransformContextnewContext()Creates a new instance of a TransformContext.voidrenderDeleteInfo(MarkupOutput out, WebObjectInfo object, boolean renderLinkAsText)voidrenderEditInfo(MarkupOutput out, WebObjectInfo object, boolean renderLinkAsText)protected voidrenderEmptyCellForActions(MarkupOutput out, boolean renderCellAsText)-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractObjectInfoListTransform
addCSSForObjectType, getCssName, getDereferenceShortcuts, getImageName, getImageTooltip, getIncrementalFetchComponent, getListItemAttributes, getNameWrapperTag, getObjectDescription, getObjectModificationTime, getObjectName, getOwnerName, getPathTransform, getVisualizationMode, getVisualizationMode, initializeImages, isUserEnabled, isVisualizationObject, isVisualizationObject, renderAbbreviationInfo, renderAbbreviationInfo, renderDescriptionInfo, renderDescriptionInfo, renderEmptyList, renderIconInfo, renderIncrementalFetch, renderIsUserEnabled, renderIsUserEnabled, renderLayeredIconInfo, renderLayeredIconInfo, renderList, renderLocationInfo, renderModifiedInfo, renderNameInfo, renderObject, renderOwnerInfo, transformForRequestSuccessful
-
Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchor, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBeanPath, getBoneId, getCancelEvent, getClientSideHelper, getContainerServices, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorMessage, getErrorTitle, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getID, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderImage, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestInError, transformForRequestNotInited, transformForRequestProcessing, transformForRequestWaitingForUserInput
-
Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform
getLayoutDefinition, setLayoutDefinition, transformUsingLayout
-
Methods inherited from class com.microstrategy.web.transform.AbstractTransform
addFormalParam, canTransform, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports, supports
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.microstrategy.web.transform.LayoutTransform
getLayoutDefinition, setLayoutDefinition
-
Methods inherited from interface com.microstrategy.web.transform.Transform
canTransform, getFormalParams, getID, getPreview, isPreviewAvailable, isResolved, supports, supports, transform
-
-
-
-
Method Detail
-
getUserEntitiesBean
protected UserEntitiesBean getUserEntitiesBean()
-
initializeTransform
public void initializeTransform(Transformable data)
Description copied from class:AbstractAppTransformThis method initialize the private and protected fields of the transform, such as width and height. It also invokes the
This method is automatically called from theinitializeWebComponent,initializeImagesandinitializeCssmethods.transformmethod. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.- Specified by:
initializeTransformin interfaceAppTransform- Overrides:
initializeTransformin classAbstractAppTransform- Parameters:
data- the bean to transform.
-
getObjectAbbreviation
public java.lang.String getObjectAbbreviation(WebObjectInfo object)
Description copied from class:AbstractObjectInfoListTransformUtility method for obtaining the abbreviation of the object being analyzed- Overrides:
getObjectAbbreviationin classAbstractObjectInfoListTransform- Parameters:
object-WebObjectInfoinstance to be processed.- Returns:
- value of the abbreviation property of the object.
-
getSortedList
public java.util.List getSortedList()
- Specified by:
getSortedListin classAbstractObjectInfoListTransform- Returns:
- a
Listinstance with all the elements from the bean to be rendered by this transform. The contents will already be sorted if required.
-
isEmptyList
public boolean isEmptyList()
- Specified by:
isEmptyListin classAbstractObjectInfoListTransform- Returns:
trueif the underlying object list is empty.
-
getSupportedBeanType
public java.lang.Class getSupportedBeanType()
Description copied from class:AbstractAppTransformReturns the supported bean type. This abstract Transform supports allWebComponentsso every sub-class should override this method to return the class of theBeanthe Transform is expecting, for example:public class CustomReportClass extends AbstractAppTransform { public Class getSupportedBeanType() { //This Transform is expected to work only with a ReportBean, //therefore this method needs to return this class: return ReportBean.class; } }- Specified by:
getSupportedBeanTypein interfaceTransform- Overrides:
getSupportedBeanTypein classAbstractAppTransform- Returns:
- a root class/interface supported by this transform.
-
getEvent
public WebEvent getEvent(WebObjectInfo object)
Description copied from class:AbstractObjectInfoListTransformGenerate the event that allows users to request actions on a given object.- Specified by:
getEventin classAbstractObjectInfoListTransform- Parameters:
object-WebObjectInfobase object for a request.- Returns:
WebEventinstance corresponding to the event enabled for theWebObjectInfoprovided. If no possible manipulation on the object is authorized,nullwill be returned.
-
getGoToEvent
public WebEvent getGoToEvent()
- Specified by:
getGoToEventin classAbstractObjectInfoListTransform- Returns:
WebEventinstance with the information for handling incremental fetch requests on the list of objects being rendered by this transform. If not supported, it will returnnull
-
getGoToArgument
public int getGoToArgument()
- Specified by:
getGoToArgumentin classAbstractObjectInfoListTransform- Returns:
- the identifier of the argument on the
AbstractObjectInfoListTransform.getGoToEvent()event where the element to navigate to will be specified.
-
getBlockPosition
protected int getBlockPosition()
- Specified by:
getBlockPositionin classAbstractObjectInfoListTransform- Returns:
- value of the property indicating the index of the first element currently being viewed as part of the list output. Used for incremental fetch purposes.
-
getBlockSize
protected int getBlockSize()
- Specified by:
getBlockSizein classAbstractObjectInfoListTransform- Returns:
- value of the property indicating the number of elements included on a single 'page' of the list output. Used for incremental fetch purposes.
-
getChildCount
protected int getChildCount()
- Specified by:
getChildCountin classAbstractObjectInfoListTransform- Returns:
- the total number of elements that are included on the list that could be rendered by this transform. Used for incremental fetch purposes.
-
getDescription
public java.lang.String getDescription()
Description copied from interface:TransformReturns a textual description of the transform.- Returns:
- The textual description of the transform.
-
isObjectNotNull
public boolean isObjectNotNull(WebObjectInfo object)
Convenience method to check object is Null.- Parameters:
object-WebObjectInfoObject to be checked for null.- Returns:
- true if the object is not null.
-
getEditEvent
public WebEvent getEditEvent(WebObjectInfo object)
-
getDeleteEvent
public WebEvent getDeleteEvent(WebObjectInfo object)
-
canCreate
public boolean canCreate()
-
canCreateGroup
public boolean canCreateGroup()
-
canCreateUser
public boolean canCreateUser()
-
canEdit
public boolean canEdit(WebObjectInfo object)
-
canDelete
public boolean canDelete(WebObjectInfo object)
-
getNewGroupEvent
public WebEvent getNewGroupEvent()
-
getNewUserEvent
public WebEvent getNewUserEvent()
-
renderEmptyCellForActions
protected void renderEmptyCellForActions(MarkupOutput out, boolean renderCellAsText)
-
renderEditInfo
public void renderEditInfo(MarkupOutput out, WebObjectInfo object, boolean renderLinkAsText)
-
renderDeleteInfo
public void renderDeleteInfo(MarkupOutput out, WebObjectInfo object, boolean renderLinkAsText)
-
getContextMenu
protected ContextMenu getContextMenu(WebObjectInfo object)
-
getContextMenuAttributes
public java.util.Map getContextMenuAttributes(WebObjectInfo object)
-
getContext
protected TransformContext getContext()
Description copied from class:AbstractAppTransformReturns the instance of TransformContext with context information for this Transform.- Overrides:
getContextin classAbstractAppTransform- See Also:
AbstractAppTransform.getContextMenu(java.lang.String)
-
newContext
protected TransformContext newContext()
Description copied from class:AbstractAppTransformCreates a new instance of a TransformContext. It's used by the getContext method the first time is invoked. Transforms who require to include extra information in the context should create their own TransformContext implementation (possibly a subclass of AppTransformContext) and returns a new instance in this method.- Overrides:
newContextin classAbstractAppTransform
-
-