wt.pdmlink
Interface PDMLinkHelperIfc

public interface PDMLinkHelperIfc

The PDMLinkHelperIfc class provides abstract access to methods in the com.ptc.windchill.pdmlink package classes from classes in Windchill foundation.

Supported API: false

Field Summary

static int	PRODUCT
static int	PRODUCT_AND_REPOSITORY
static int	REPOSITORY

Method Summary

QueryResult	getEligibleCabinetsByType(int typeToReturn) Returns the wt.folder.Cabinet objects of the specified type to which the current principal has read access.
Object[]	getEligibleRepositoriesByType(int typeToReturn) Returns the PDMLinkRepository objects of the specified type to which the current principal has read access.
Cabinet	getRepositoryCabinet(Object repository) Returns the cabinet associated with a PDMLinkRepository object.
String	getRepositoryName(DomainAdministered obj) Returns the name of the PDMLink repository to which the given object belongs.
String	getRepositoryName(Object repository) Get the name of a PDMLinkRepository Supported API: false
String	getRepositoryObjectReference(Object repository) Returns the oid of a PDMLinkRepository object.
boolean	isEligibleCabinet(String cabinetName, int typeToReturn) Returns true if there is a cabinet of the specified type with the specified name and the current principal has READ access to it.

Field Detail

PRODUCT

public static final int PRODUCT

See Also:

Constant Field Values

REPOSITORY

public static final int REPOSITORY

See Also:

Constant Field Values

PRODUCT_AND_REPOSITORY

public static final int PRODUCT_AND_REPOSITORY

See Also:

Constant Field Values

Method Detail

getEligibleCabinetsByType

public QueryResult getEligibleCabinetsByType(int typeToReturn)
                                      throws WTException

Returns the wt.folder.Cabinet objects of the specified type to which the current principal has read access. Template cabinets are not returned.

Supported API: false

Parameters:

typeToReturn - - valid values are PRODUCT, REPOSITORY, and PRODUCT_AND_REPOSITORY from wt.pdmlink.PDMLinkHelperIfc

Throws:

WTException

isEligibleCabinet

public boolean isEligibleCabinet(String cabinetName,
                                 int typeToReturn)
                          throws WTException

Returns true if there is a cabinet of the specified type with the specified name and the current principal has READ access to it. If the user does not have permission to access the cabinet for READ then false is returned. If the cabinetName is the name of a template cabinet of the typeToReturn domain then false is returned.

Supported API: false

Parameters:

cabinetName - - name of cabinet

typeToReturn - - valid values are PRODUCT, REPOSITORY, and PRODUCT_AND_REPOSITORY from wt.pdmlink.PDMLinkHelperIfc

Throws:

WTException

getRepositoryName

public String getRepositoryName(DomainAdministered obj)
                         throws WTException

Returns the name of the PDMLink repository to which the given object belongs. If object is not associated with a repository, returns null.

Supported API: false

Returns:

PDMLinkRepository name or null if object is not associated with a repository

Throws:

WTException

getRepositoryName

public String getRepositoryName(Object repository)
                         throws WTException

Get the name of a PDMLinkRepository

Supported API: false

Parameters:

repository - a PDMLinkRepository object

Returns:

PDMLinkRepository name or null if object is not a PDMLinkRepository

Throws:

WTException

getRepositoryCabinet

public Cabinet getRepositoryCabinet(Object repository)
                             throws WTException

Returns the cabinet associated with a PDMLinkRepository object. Throws an exception if the input argument is not a PDMLinkRepository object.

Supported API: false

Parameters:

repository - - PDMLinkRepository whose cabinet is needed

Returns:

cabinet

Throws:

WTException

getRepositoryObjectReference

public String getRepositoryObjectReference(Object repository)
                                    throws WTException

Returns the oid of a PDMLinkRepository object. Throws an exception if the input argument is not a PDMLinkRepository object.

Supported API: false

Returns:

object reference

Throws:

WTException

getEligibleRepositoriesByType

public Object[] getEligibleRepositoriesByType(int typeToReturn)
                                       throws WTException

Returns the PDMLinkRepository objects of the specified type to which the current principal has read access. Casts repositories as Objects for use in wt packages. Template cabinets are not returned.

Supported API: false

Parameters:

typeToReturn - - valid values are PRODUCT, REPOSITORY, and PRODUCT_AND_REPOSITORY from wt.pdmlink.PDMLinkHelperIfc

Returns:

PDMLinkRepository objects

Throws:

WTException