|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface defining how the portal reads and writes its channel types, definitions, and categories.
Method Summary | |
void |
addCategoryToCategory(ChannelCategory source,
ChannelCategory destination)
Makes one category a child of another. |
void |
addChannelToCategory(ChannelDefinition channelDef,
ChannelCategory category)
Associates a channel definition with a category. |
void |
approveChannelDefinition(ChannelDefinition channelDef,
IPerson approver,
java.util.Date approveDate)
Sets a channel definition as "approved". |
void |
deleteChannelCategory(ChannelCategory category)
Deletes a channel category. |
void |
deleteChannelDefinition(ChannelDefinition channelDef)
Permanently deletes a channel definition from the store. |
void |
deleteChannelType(ChannelType chanType)
Deletes a channel type. |
void |
disapproveChannelDefinition(ChannelDefinition channelDef)
Sets a channel definition as "unapproved". |
ChannelCategory |
getChannelCategory(java.lang.String channelCategoryId)
Gets an existing channel category. |
ChannelDefinition |
getChannelDefinition(int channelPublishId)
Get a channel definition. |
ChannelDefinition |
getChannelDefinition(java.lang.String channelFunctionalName)
Get a channel definition. |
ChannelDefinition[] |
getChannelDefinitions()
Get all channel definitions including ones that haven't been approved. |
ChannelType |
getChannelType(int channelTypeId)
Get the channel type associated with a particular identifier. |
ChannelType[] |
getChannelTypes()
Returns an array of ChannelTypes. |
ChannelCategory[] |
getChildCategories(ChannelCategory parent)
Gets all child channel categories for a parent category. |
ChannelDefinition[] |
getChildChannels(ChannelCategory parent)
Gets all child channel definitions for a parent category. |
ChannelCategory[] |
getParentCategories(ChannelCategory child)
Gets the immediate parent categories of this category. |
ChannelCategory[] |
getParentCategories(ChannelDefinition child)
Gets the immediate parent categories of this channel definition. |
ChannelCategory |
getTopLevelChannelCategory()
Gets top level channel category |
ChannelCategory |
newChannelCategory()
Creates a new channel category. |
ChannelCategory |
newChannelCategory(java.lang.String name,
java.lang.String description,
java.lang.String creatorId)
Creates a new channel category with the specified values. |
ChannelDefinition |
newChannelDefinition()
Create a new ChannelDefinition object. |
ChannelType |
newChannelType()
Creates a new channel type. |
void |
removeCategoryFromCategory(ChannelCategory child,
ChannelCategory parent)
Makes one category a child of another. |
void |
removeChannelFromCategory(ChannelDefinition channelDef,
ChannelCategory category)
Disassociates a channel definition from a category. |
void |
saveChannelCategory(ChannelCategory category)
Persists a channel category. |
void |
saveChannelDefinition(ChannelDefinition channelDef)
Persists a channel definition. |
void |
saveChannelType(ChannelType chanType)
Persists a channel type. |
Method Detail |
public ChannelType newChannelType() throws java.lang.Exception
java.lang.Exception
public ChannelType getChannelType(int channelTypeId) throws java.lang.Exception
channelTypeId
- the channel type identifier
java.lang.Exception
public ChannelType[] getChannelTypes() throws java.lang.Exception
java.lang.Exception
public void saveChannelType(ChannelType chanType) throws java.lang.Exception
chanType
- a channel type
java.lang.Exception
public void deleteChannelType(ChannelType chanType) throws java.lang.Exception
chanType
- a channel type
java.lang.Exception
public ChannelDefinition newChannelDefinition() throws java.lang.Exception
java.lang.Exception
public ChannelDefinition getChannelDefinition(int channelPublishId) throws java.lang.Exception
channelPublishId
- a channel publish ID
null
if no matching channel definition can be found
java.lang.Exception
public ChannelDefinition getChannelDefinition(java.lang.String channelFunctionalName) throws java.lang.Exception
channelFunctionalName
- a channel functional name
null
if no matching channel definition can be found
java.lang.Exception
public ChannelDefinition[] getChannelDefinitions() throws java.lang.Exception
java.lang.Exception
public void saveChannelDefinition(ChannelDefinition channelDef) throws java.lang.Exception
channelDef
- the channel definition
java.lang.Exception
public void deleteChannelDefinition(ChannelDefinition channelDef) throws java.lang.Exception
channelDef
- the channel definition
java.lang.Exception
public void approveChannelDefinition(ChannelDefinition channelDef, IPerson approver, java.util.Date approveDate) throws java.lang.Exception
channelDef
- the channel definitionapprover
- the user that approves this channel definitionapproveDate
- the date when the channel definition should be approved (can be future dated)
java.lang.Exception
public void disapproveChannelDefinition(ChannelDefinition channelDef) throws java.lang.Exception
channelDef
- the channel definition
java.lang.Exception
public ChannelCategory newChannelCategory() throws java.lang.Exception
java.lang.Exception
public ChannelCategory newChannelCategory(java.lang.String name, java.lang.String description, java.lang.String creatorId) throws java.lang.Exception
name
- the name of the categorydescription
- the name of the descriptioncreatorId
- the id of the creator or system
java.lang.Exception
public ChannelCategory getChannelCategory(java.lang.String channelCategoryId) throws java.lang.Exception
channelCategoryId
- the id of the category to get
java.lang.Exception
public ChannelCategory getTopLevelChannelCategory() throws java.lang.Exception
java.lang.Exception
public ChannelCategory[] getChildCategories(ChannelCategory parent) throws java.lang.Exception
java.lang.Exception
public ChannelDefinition[] getChildChannels(ChannelCategory parent) throws java.lang.Exception
java.lang.Exception
public ChannelCategory[] getParentCategories(ChannelCategory child) throws java.lang.Exception
java.lang.Exception
public ChannelCategory[] getParentCategories(ChannelDefinition child) throws java.lang.Exception
java.lang.Exception
public void saveChannelCategory(ChannelCategory category) throws java.lang.Exception
category
- the channel category to persist
java.lang.Exception
public void deleteChannelCategory(ChannelCategory category) throws java.lang.Exception
category
- the channel category to delete
java.lang.Exception
public void addCategoryToCategory(ChannelCategory source, ChannelCategory destination) throws java.lang.Exception
source
- the source categorydestination
- the destination category
java.lang.Exception
public void removeCategoryFromCategory(ChannelCategory child, ChannelCategory parent) throws java.lang.Exception
child
- the category to removeparent
- the category to remove from
java.lang.Exception
public void addChannelToCategory(ChannelDefinition channelDef, ChannelCategory category) throws java.lang.Exception
channelDef
- the channel definitioncategory
- the channel category to which to associate the channel definition
java.lang.Exception
public void removeChannelFromCategory(ChannelDefinition channelDef, ChannelCategory category) throws java.lang.Exception
channelDef
- the channel definitioncategory
- the channel category from which to disassociate the channel definition
java.lang.Exception
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |