|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.RDBMChannelRegistryStore
Reference implementation of IChannelRegistryStore.
Constructor Summary | |
RDBMChannelRegistryStore()
|
Method Summary | |
void |
addCategoryToCategory(ChannelCategory child,
ChannelCategory parent)
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)
Removes a channel from the channel registry by changing its status from "approved" to "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()
Get channel types. |
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()
Create a new ChannelType object. |
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. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public RDBMChannelRegistryStore()
Method Detail |
public ChannelType newChannelType() throws java.lang.Exception
newChannelType
in interface IChannelRegistryStore
java.lang.Exception
public ChannelType getChannelType(int channelTypeId) throws java.sql.SQLException
getChannelType
in interface IChannelRegistryStore
channelTypeId
- the channel type identifier
java.sql.SQLException
public ChannelType[] getChannelTypes() throws java.sql.SQLException
getChannelTypes
in interface IChannelRegistryStore
java.sql.SQLException
public void saveChannelType(ChannelType chanType) throws java.sql.SQLException
saveChannelType
in interface IChannelRegistryStore
chanType
- a channel type
java.sql.SQLException
public void deleteChannelType(ChannelType chanType) throws java.sql.SQLException
deleteChannelType
in interface IChannelRegistryStore
chanType
- a channel type
java.sql.SQLException
public ChannelDefinition newChannelDefinition() throws java.lang.Exception
newChannelDefinition
in interface IChannelRegistryStore
java.lang.Exception
public ChannelDefinition getChannelDefinition(int channelPublishId) throws java.sql.SQLException
getChannelDefinition
in interface IChannelRegistryStore
channelPublishId
- a channel publish ID
null
if no matching channel definition can be found
java.sql.SQLException
public ChannelDefinition getChannelDefinition(java.lang.String channelFunctionalName) throws java.sql.SQLException
getChannelDefinition
in interface IChannelRegistryStore
channelFunctionalName
- a channel functional name
null
if no matching channel definition can be found
java.sql.SQLException
public ChannelDefinition[] getChannelDefinitions() throws java.sql.SQLException
getChannelDefinitions
in interface IChannelRegistryStore
java.sql.SQLException
public void saveChannelDefinition(ChannelDefinition channelDef) throws java.lang.Exception
saveChannelDefinition
in interface IChannelRegistryStore
channelDef
- the channel definition
java.sql.SQLException
java.lang.Exception
public void deleteChannelDefinition(ChannelDefinition channelDef) throws java.sql.SQLException, GroupsException
deleteChannelDefinition
in interface IChannelRegistryStore
channelDef
- the channel definition
java.sql.SQLException
GroupsException
public void approveChannelDefinition(ChannelDefinition channelDef, IPerson approver, java.util.Date approveDate) throws java.lang.Exception
approveChannelDefinition
in interface IChannelRegistryStore
channelDef
- the channel definition to approveapprover
- 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
disapproveChannelDefinition
in interface IChannelRegistryStore
channelDef
- the channel definition to disapprove
java.lang.Exception
public ChannelCategory newChannelCategory() throws GroupsException
newChannelCategory
in interface IChannelRegistryStore
GroupsException
public ChannelCategory newChannelCategory(java.lang.String name, java.lang.String description, java.lang.String creatorId) throws GroupsException
newChannelCategory
in interface IChannelRegistryStore
name
- the name of the categorydescription
- the name of the descriptioncreatorId
- the id of the creator or system
GroupsException
public ChannelCategory getChannelCategory(java.lang.String channelCategoryId) throws GroupsException
getChannelCategory
in interface IChannelRegistryStore
channelCategoryId
- the id of the category to get
GroupsException
public ChannelCategory getTopLevelChannelCategory() throws GroupsException
getTopLevelChannelCategory
in interface IChannelRegistryStore
GroupsException
public ChannelCategory[] getChildCategories(ChannelCategory parent) throws GroupsException
getChildCategories
in interface IChannelRegistryStore
GroupsException
public ChannelDefinition[] getChildChannels(ChannelCategory parent) throws java.sql.SQLException, GroupsException
getChildChannels
in interface IChannelRegistryStore
java.sql.SQLException
GroupsException
public ChannelCategory[] getParentCategories(ChannelCategory child) throws GroupsException
getParentCategories
in interface IChannelRegistryStore
GroupsException
public ChannelCategory[] getParentCategories(ChannelDefinition child) throws GroupsException
getParentCategories
in interface IChannelRegistryStore
GroupsException
public void saveChannelCategory(ChannelCategory category) throws GroupsException
saveChannelCategory
in interface IChannelRegistryStore
category
- the channel category to persist
GroupsException
public void deleteChannelCategory(ChannelCategory category) throws GroupsException
deleteChannelCategory
in interface IChannelRegistryStore
category
- the channel category to delete
GroupsException
public void addCategoryToCategory(ChannelCategory child, ChannelCategory parent) throws GroupsException
addCategoryToCategory
in interface IChannelRegistryStore
child
- the source categoryparent
- the destination category
GroupsException
public void removeCategoryFromCategory(ChannelCategory child, ChannelCategory parent) throws GroupsException
removeCategoryFromCategory
in interface IChannelRegistryStore
child
- the category to removeparent
- the category to remove from
GroupsException
public void addChannelToCategory(ChannelDefinition channelDef, ChannelCategory category) throws PortalException
addChannelToCategory
in interface IChannelRegistryStore
channelDef
- the channel definitioncategory
- the channel category to which to associate the channel definition
PortalException
public void removeChannelFromCategory(ChannelDefinition channelDef, ChannelCategory category) throws PortalException
removeChannelFromCategory
in interface IChannelRegistryStore
channelDef
- the channel definitioncategory
- the channel category from which to disassociate the channel definition
PortalException
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |