IXTypeService (server-common-api)

```
public interface IXTypeService
```
Title: IXTypeService The XType Service is the main interface to manage, create, delete, and view XTypes. An XType represents a particular implementation of a base type. It is also known as a DBO (Dynamic Business Object) Use the strings below to acquire the standard implementation of a base type. ex: getXTypeID(IXTypeService.FOLDER) will return the ID of the standard implementation of folder. Note that the standard implementation can be modifed or removed. definitions xtypeID: int value of the xtype xtype: instance of IXType typeID: int value of base type

See Also:

IXType, ITypeService

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ARCHIVED` archived xtype
`static String`	`BASIC` basic xtype
`static String`	`CONTENT` content xtype
`static String`	`FOLDER` folder xtype
`static String`	`FORM` form xtype
`static String`	`GROUP` group xtype
`static String`	`LINK` link xtype
`static String`	`PORTLET` porlet xtype.
`static String`	`RELATIONSHIP` relationship xtype
`static String`	`ROLE` role xtype
`static String`	`SCHEDULE` schedule xtype
`static String`	`SERVICE` service xtype
`static String`	`STYLE` style xtype
`static String`	`SUBSCRIPTION` subscription xtype
`static String`	`TASK` Task xtype
`static String`	`TEMPLATE` template xtype
`static String`	`TOPIC` topic xtype
`static String`	`USER` user xtype
`static String`	`WORKSPACE` workspace xtype.
`static String`	`XTYPE` xtype xtype yes indeed

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`convertXType(int xtypeOld, int xtypeNew)` converts all things of old type to new type.
`int`	`getDefaultXTypeIDForTypeID(int typeID)` gets the default xtypeID for the given typeID
`IXType`	`getXType(int xtypeID)` gets the xtype thing
`IXType`	`getXType(String xtypeName)` gets the xtype thing
`IThingFactory`	`getXTypeFactory(int xtypeID)` gets the factory for this XType
`int`	`getXTypeID(String xtypeName)` looks up XType by name
`String`	`getXTypeName(int xtypeID)` gets the name of the xtype
`Collection<IXType>`	`getXTypes()` Returns collection of all registered xtypes
`IThingID`	`getXTypesFolderID()` gets the default folder for xtypes usually /meta/pmDB/folder/0000000029
`IThingIDList`	`getXTypesForType(int type)` gets a list of all xtypes for a given type
`int`	`getXTypeTypeID(int xtypeID)` gets the base type for the XType
`int`	`getXTypextypeID()` gets the default xtypeID of the xtype base type This is generally the first DB call during startup, so if it fails your system is hosed.
`void`	`invalidate()` invalidate other servers in cluster called when an XType has been added/deleted internal use only
`void`	`invalidateClasses(String[] classes)` invalidate other servers in cluster called when an XType has been added/deleted internal use only
`boolean`	`isValidXType(int xtypeID)`
`boolean`	`isValidXType(String xtypeName)`
`IThingIDList`	`listXTypeThingIDs(int xtypeID, int begin, int end)` List all things of that xtype
`void`	`registerXType(int basetype, String name, String factory, String spDestroy)` creates a new XType You should use `IPortletProvider` to create new xtypes internal use only
`void`	`unregisterXType(int xtypeID)` removes an XType.

- Field Detail
  - BASIC
```
static final String BASIC
```
    basic xtype
    
    See Also:
    
    Constant Field Values
  - FOLDER
```
static final String FOLDER
```
    folder xtype
    
    See Also:
    
    Constant Field Values
  - TOPIC
```
static final String TOPIC
```
    topic xtype
    
    See Also:
    
    Constant Field Values
  - CONTENT
```
static final String CONTENT
```
    content xtype
    
    See Also:
    
    Constant Field Values
  - LINK
```
static final String LINK
```
    link xtype
    
    See Also:
    
    Constant Field Values
  - FORM
```
static final String FORM
```
    form xtype
    
    See Also:
    
    Constant Field Values
  - WORKSPACE
```
static final String WORKSPACE
```
    workspace xtype. Formerly called PAGE
    
    See Also:
    
    Constant Field Values
  - TEMPLATE
```
static final String TEMPLATE
```
    template xtype
    
    See Also:
    
    Constant Field Values
  - PORTLET
```
static final String PORTLET
```
    porlet xtype. Formerly called WIDGET
    
    See Also:
    
    Constant Field Values
  - USER
```
static final String USER
```
    user xtype
    
    See Also:
    
    Constant Field Values
  - GROUP
```
static final String GROUP
```
    group xtype
    
    See Also:
    
    Constant Field Values
  - ROLE
```
static final String ROLE
```
    role xtype
    
    See Also:
    
    Constant Field Values
  - TASK
```
static final String TASK
```
    Task xtype
    
    See Also:
    
    Constant Field Values
  - SERVICE
```
static final String SERVICE
```
    service xtype
    
    See Also:
    
    Constant Field Values
  - ARCHIVED
```
static final String ARCHIVED
```
    archived xtype
    
    See Also:
    
    Constant Field Values
  - SUBSCRIPTION
```
static final String SUBSCRIPTION
```
    subscription xtype
    
    See Also:
    
    Constant Field Values
  - SCHEDULE
```
static final String SCHEDULE
```
    schedule xtype
    
    See Also:
    
    Constant Field Values
  - RELATIONSHIP
```
static final String RELATIONSHIP
```
    relationship xtype
    
    See Also:
    
    Constant Field Values
  - XTYPE
```
static final String XTYPE
```
    xtype xtype yes indeed
    
    See Also:
    
    Constant Field Values
  - STYLE
```
static final String STYLE
```
    style xtype
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getXTypextypeID
```
int getXTypextypeID()
```
    gets the default xtypeID of the xtype base type This is generally the first DB call during startup, so if it fails your system is hosed.
  - getDefaultXTypeIDForTypeID
```
int getDefaultXTypeIDForTypeID(int typeID)
```
    gets the default xtypeID for the given typeID
  - getXTypeID
```
int getXTypeID(String xtypeName)
```
    looks up XType by name
  - isValidXType
```
boolean isValidXType(String xtypeName)
```
    Returns:
    
    true if name exists
  - isValidXType
```
boolean isValidXType(int xtypeID)
```
    Returns:
    
    true if name exists
  - getXType
```
IXType getXType(int xtypeID)
```
    gets the xtype thing
  - getXType
```
IXType getXType(String xtypeName)
```
    gets the xtype thing
  - getXTypes
```
Collection<IXType> getXTypes()
```
    Returns collection of all registered xtypes
  - getXTypeName
```
String getXTypeName(int xtypeID)
```
    gets the name of the xtype
    
    Parameters:
    
    xtypeID -
    
    Returns:
  - getXTypeTypeID
```
int getXTypeTypeID(int xtypeID)
```
    gets the base type for the XType
  - getXTypeFactory
```
IThingFactory getXTypeFactory(int xtypeID)
```
    gets the factory for this XType
  - getXTypesForType
```
IThingIDList getXTypesForType(int type)
                       throws MetaException
```
    gets a list of all xtypes for a given type
    
    Throws:
    
    MetaException
  - invalidate
```
void invalidate()
```
    invalidate other servers in cluster called when an XType has been added/deleted internal use only
  - invalidateClasses
```
void invalidateClasses(String[] classes)
```
    invalidate other servers in cluster called when an XType has been added/deleted internal use only
  - listXTypeThingIDs
```
IThingIDList listXTypeThingIDs(int xtypeID,
                               int begin,
                               int end)
                        throws MetaException
```
    List all things of that xtype
    
    Parameters:
    
    xtypeID - xtype to search for
    
    begin -
    
    end - -1 mean all
    
    Returns:
    
    list of things
    
    Throws:
    
    MetaException
  - getXTypesFolderID
```
IThingID getXTypesFolderID()
```
    gets the default folder for xtypes usually /meta/pmDB/folder/0000000029
  - registerXType
```
void registerXType(int basetype,
                   String name,
                   String factory,
                   String spDestroy)
            throws MetaException
```
    creates a new XType You should use IPortletProvider to create new xtypes internal use only
    
    Parameters:
    
    basetype - see IThingType
    
    name - Name of xtype, must be unique, don't recommend weird chars
    
    factory - Xtype factory class (NOT xtype impl) IThingFactory
    
    spDestroy - Called when xtype instance is destroyed (not when xtype is unregistered)
    
    Throws:
    
    MetaException
  - unregisterXType
```
void unregisterXType(int xtypeID)
              throws MetaException
```
    removes an XType. Will fail if there are any things of this type You should use IPortletProvider to remove xtypes internal use only
    
    Parameters:
    
    xtypeID - to delete
    
    Throws:
    
    MetaException
  - convertXType
```
void convertXType(int xtypeOld,
                  int xtypeNew)
           throws MetaException
```
    converts all things of old type to new type. Useful if old type is being deleted.
    
    Parameters:
    
    xtypeOld -
    
    xtypeNew -
    
    Throws:
    
    MetaException

Interface IXTypeService

Field Summary

Method Summary

Field Detail

BASIC

FOLDER

TOPIC

CONTENT

LINK

FORM

WORKSPACE

TEMPLATE

PORTLET

USER

GROUP

ROLE

TASK

SERVICE

ARCHIVED

SUBSCRIPTION

SCHEDULE

RELATIONSHIP

XTYPE

STYLE

Method Detail

getXTypextypeID

getDefaultXTypeIDForTypeID

getXTypeID

isValidXType

isValidXType

getXType

getXType

getXTypes

getXTypeName

getXTypeTypeID

getXTypeFactory

getXTypesForType

invalidate

invalidateClasses

listXTypeThingIDs

getXTypesFolderID

registerXType

unregisterXType

convertXType