com.tsgrp.opencontent.dctm.utilities

Class DctmUtil

java.lang.Object

com.tsgrp.opencontent.dctm.utilities.DctmUtil

public class DctmUtil
extends java.lang.Object

Service that provides content access and manipulation methods.

Constructor Summary

Constructors

Constructor and Description
DctmUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	ACLIntToString(int permission) Helper function to convert an ACL Integer to its String representation
static java.lang.Integer	ACLStringToInt(java.lang.String permission) Helper function to convert an ACL String to its int representation
static java.util.Set<java.lang.String>	getAclsForCurrentUser(java.lang.String ticket, int minPermitLevel) Method retrieves the ACLs for the current user The fullQueryString is created and executed and the convenience method getCurrentUserLoginName() above is called
static java.lang.String	getCurrentUserLoginName(java.lang.String ticket) Convenience method that retrieves the user's login name
static java.lang.String	getIdByPathOrId(java.lang.String ticket, java.lang.String pathOrId) This method fetches an id value based on a provided variable that can be either a path to an object or an objectId.
static java.util.List<QueryResultRow>	parseQueryResults(com.tsgrp.util.dctm.Result result) parseQueryResults
static void	queueRenditionRequest(java.lang.String ticket, java.lang.String objectId) Convenience method for adding a rendition to the queue.
static java.lang.String	resolveDisplayName(java.lang.String ticket, java.lang.String userLoginNameOrDisplayName) Helper method that takes in either a Documentum user's login name or a Documentum user's display name, and returns the Documentum user's display name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DctmUtil

public DctmUtil()

Method Detail

parseQueryResults

public static java.util.List<QueryResultRow> parseQueryResults(com.tsgrp.util.dctm.Result result)

parseQueryResults

Parameters:

result -

Returns:

List

getCurrentUserLoginName

public static java.lang.String getCurrentUserLoginName(java.lang.String ticket)

Convenience method that retrieves the user's login name

Parameters:

ticket -

Returns:

String - the user's login name

queueRenditionRequest

public static void queueRenditionRequest(java.lang.String ticket,
                                         java.lang.String objectId)
                                  throws com.documentum.fc.common.DfException

Convenience method for adding a rendition to the queue.

Parameters:

ticket -

objectId -

Throws:

com.documentum.fc.common.DfException

getAclsForCurrentUser

public static java.util.Set<java.lang.String> getAclsForCurrentUser(java.lang.String ticket,
                                                                    int minPermitLevel)

Method retrieves the ACLs for the current user The fullQueryString is created and executed and the convenience method getCurrentUserLoginName() above is called

Parameters:

ticket - - login ticket assigned upon login

minPermitLevel -

Returns:

Set - list of ACLs

resolveDisplayName

public static java.lang.String resolveDisplayName(java.lang.String ticket,
                                                  java.lang.String userLoginNameOrDisplayName)

Helper method that takes in either a Documentum user's login name or a Documentum user's display name, and returns the Documentum user's display name.

Parameters:

ticket -

userLoginNameOrDisplayName -

Returns:

getIdByPathOrId

public static java.lang.String getIdByPathOrId(java.lang.String ticket,
                                               java.lang.String pathOrId)

This method fetches an id value based on a provided variable that can be either a path to an object or an objectId. If pathOrId is an objectId, it returns pathOrId, otherwise it returns the objectId of the object specified by the pathOrId

Parameters:

ticket - the OC ticket for validation

pathOrId - the path or id for which to find the objectId

Returns:

an objectId of the object specified by the pathOrId parameter

ACLIntToString

public static java.lang.String ACLIntToString(int permission)

Helper function to convert an ACL Integer to its String representation

Parameters:

permission - - The ACL int

Returns:

the ACL String value

ACLStringToInt

public static java.lang.Integer ACLStringToInt(java.lang.String permission)

Helper function to convert an ACL String to its int representation

Parameters:

permission - - The ACL String

Returns:

the ACL Integer value