public interface TypeManager
Type
objects in the Escenic system. See
Type
for details on types.Type
,
Type.Category
Modifier and Type | Method and Description |
---|---|
void |
createType(Type.Category category,
String value)
Creates a new type.
|
Type |
getType(Publication pub,
Type.Category category,
int id)
Looks for a type in a category with a specific id
that is allowed in the specified publication.
|
Type |
getType(Publication pub,
Type.Category category,
String name)
Looks for a type in a category with a specific name
that is allowed in the specified publication.
|
Type |
getType(Publication pub,
Type type)
Looks up a specified
Type that is allowed in the
specified publication. |
Type |
getType(Type.Category category,
int id)
Looks for a type in a category with a specific id.
|
Type |
getType(Type.Category category,
String name)
Looks for a type in a category with a specific name.
|
Type |
getType(Type type)
Retrieves the specified Type.
|
Type[] |
getTypes(Publication pub,
Type.Category category)
Retrieves all
Type objects of the requested category that
is allowed in the specified publication. |
Type[] |
getTypes(Type.Category category)
Retrieves all possible Type objects of the requested
category.
|
void |
resetType(Type.Category category)
Removes this type from the internal cache.
|
void createType(Type.Category category, String value) throws PersistentStoreException
category
- the category of Type
object to createvalue
- the value of the Type
object to createPersistentStoreException
- if an error occurs in the persistence layerUnsupportedOperationException
- if trying to create a category type that is not supportedType
,
Type.Category
Type[] getTypes(Type.Category category) throws PersistentStoreException
category
- The category of Type objects to getPersistentStoreException
- if an error occurs in the persistence layerType
,
Type.Category
Type getType(Type type) throws PersistentStoreException
type
- The type to look for.PersistentStoreException
- if an error occurs in the persistence layerType
,
Type.Category
Type getType(Type.Category category, int id) throws PersistentStoreException
category
- the category to search.id
- the id to look for.PersistentStoreException
- if an error occurs in the persistence layerType
,
Type.Category
Type getType(Type.Category category, String name) throws PersistentStoreException
category
- the category to search.name
- the name to look for.PersistentStoreException
- if an error occurs in the persistence layerType
,
Type.Category
Type[] getTypes(Publication pub, Type.Category category) throws PersistentStoreException
Type
objects of the requested category that
is allowed in the specified publication.pub
- the publicationcategory
- the category of Type
objects to getPersistentStoreException
- if an error occurs in the persistence layerType
,
Type.Category
Type getType(Publication pub, Type type) throws PersistentStoreException
Type
that is allowed in the
specified publication.
If the type parameter has a name, the returned value will be the Type
with that name. Otherwise, if it has an id, the method will search for
a type with that id. If neither name nor id is specified, null is
returned.pub
- the publicationtype
- the type to look for.PersistentStoreException
- if an error occurs in the persistence layerType
,
Type.Category
Type getType(Publication pub, Type.Category category, int id) throws PersistentStoreException
pub
- the publicationcategory
- the category to search.id
- the id to look for.PersistentStoreException
- if an error occurs in the persistence layerType
,
Type.Category
Type getType(Publication pub, Type.Category category, String name) throws PersistentStoreException
pub
- the publicationcategory
- the category to search.name
- the name to look for.PersistentStoreException
- if an error occurs in the persistence layerType
,
Type.Category
void resetType(Type.Category category)
category
- the type to be flushed from the internal cacheType
,
Type.Category
© 1998- 2018 Stibo DX