FdnWTContainerService

@RemoteInterface public interface FdnWTContainerService

Provides APIs to assist clients in determining what objects the user can create.

Supported API: true

Extendable: false

Method Summary

Modifier and Type

Method

Description

TypeIdentifier[]

getCreatableTypesForWTContainer(WTContainer container, TypeIdentifier baseType, AdminDomainRef subDomainRef)

Returns a list of the types the user can create in the given container.

TypeIdentifier[]

getTypesForWTContainer(WTContainer container, TypeIdentifier baseType, AdminDomainRef subDomainRef, Boolean includeDesc)

Returns an array of TypeIdentifiers in the given container.

Method Details
- getCreatableTypesForWTContainer
  
  TypeIdentifier[] getCreatableTypesForWTContainer(WTContainer container, TypeIdentifier baseType, AdminDomainRef subDomainRef) throws WTException
  
  Returns a list of the types the user can create in the given container. Does this by getting the life cycle template from the init rule for each type, getting the template's first state, and then checking for create access in the specified sub domain. If no domain is specified the default domain of the container is used. If there is no rule assigning a life cycle template, this API will not return that type in the list even if the user may potentially be able to create it.
  
  Supported API: true
  
  Parameters:
  
  container -
  
  baseType -
  
  subDomainRef -
  
  Returns:
  
  TypeIdentifier[]
  
  Throws:
  
  WTException
- getTypesForWTContainer
  
  TypeIdentifier[] getTypesForWTContainer(WTContainer container, TypeIdentifier baseType, AdminDomainRef subDomainRef, Boolean includeDesc) throws WTException
  
  Returns an array of TypeIdentifiers in the given container. By passing true to includeDesc, all descendants including both direct and indirect are returned.
  
  Supported API: true
  
  Parameters:
  
  container -
  
  baseType -
  
  subDomainRef -
  
  includeDesc -
  
  Returns:
  
  TypeIdentifier[]
  
  Throws:
  
  WTException