Java Doc for IChannelRegistryStore.java in » Portal » uPortal_rel-2-6-1-GA » org » jasig » portal » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Portal » uPortal_rel 2 6 1 GA » org.jasig.portal

Source Cross Reference Class Diagram Java Document (Java Doc)

org.jasig.portal .IChannelRegistryStore

All known Subclasses:   org.jasig.portal .RDBMChannelRegistryStore,
IChannelRegistryStore
public interface IChannelRegistryStore (Code)
Interface defining how the portal reads and writes its channel types, definitions, and categories.
author:
   Ken Weiner, kweiner@unicon.net
version:
   $Revision: 36683 $

Method Summary
public void addCategoryToCategory(ChannelCategory source, ChannelCategory destination)
     Makes one category a child of another.
public void addChannelToCategory(ChannelDefinition channelDef, ChannelCategory category)
     Associates a channel definition with a category.
public void approveChannelDefinition(ChannelDefinition channelDef, IPerson approver, Date approveDate)
     Sets a channel definition as "approved".
public void deleteChannelCategory(ChannelCategory category)
     Deletes a channel category.
public void deleteChannelDefinition(ChannelDefinition channelDef)
     Permanently deletes a channel definition from the store.
public void deleteChannelType(ChannelType chanType)
     Deletes a channel type.
public void disapproveChannelDefinition(ChannelDefinition channelDef)
     Sets a channel definition as "unapproved".
public ChannelCategory getChannelCategory(String channelCategoryId)
     Gets an existing channel category.
public ChannelDefinition getChannelDefinition(int channelPublishId)
     Get a channel definition.
public ChannelDefinition getChannelDefinition(String channelFunctionalName)
     Get a channel definition.
public ChannelDefinition[] getChannelDefinitions()
     Get all channel definitions including ones that haven't been approved.
public ChannelType getChannelType(int channelTypeId)
     Get the channel type associated with a particular identifier.
public ChannelType[] getChannelTypes()
     Returns an array of ChannelTypes.
public ChannelCategory[] getChildCategories(ChannelCategory parent)
     Gets all child channel categories for a parent category.
public ChannelDefinition[] getChildChannels(ChannelCategory parent)
     Gets all child channel definitions for a parent category.
public ChannelCategory[] getParentCategories(ChannelCategory child)
     Gets the immediate parent categories of this category.
public ChannelCategory[] getParentCategories(ChannelDefinition child)
     Gets the immediate parent categories of this channel definition.
public ChannelCategory getTopLevelChannelCategory()

public ChannelCategory newChannelCategory()
     Creates a new channel category.
public ChannelCategory newChannelCategory(String name, String description, String creatorId)
     Creates a new channel category with the specified values.
public ChannelDefinition newChannelDefinition()
     Create a new ChannelDefinition object.
public ChannelDefinition newChannelDefinition(int id)
     Create a new ChannelDefinition object.
public ChannelType newChannelType()
     Creates a new channel type.
public void removeCategoryFromCategory(ChannelCategory child, ChannelCategory parent)
     Makes one category a child of another.
public void removeChannelFromCategory(ChannelDefinition channelDef, ChannelCategory category)
     Disassociates a channel definition from a category.
public void saveChannelCategory(ChannelCategory category)
     Persists a channel category.
public void saveChannelDefinition(ChannelDefinition channelDef)
     Persists a channel definition.
public void saveChannelType(ChannelType chanType)
     Persists a channel type.

Method Detail
addCategoryToCategory
public void addCategoryToCategory(ChannelCategory source, ChannelCategory destination) throws Exception(Code)
Makes one category a child of another.
Parameters:
  source - the source category
Parameters:
  destination - the destination category
throws:
  java.lang.Exception -

addChannelToCategory
public void addChannelToCategory(ChannelDefinition channelDef, ChannelCategory category) throws Exception(Code)
Associates a channel definition with a category.
Parameters:
  channelDef - the channel definition
Parameters:
  category - the channel category to which to associate the channel definition
throws:
  java.lang.Exception -

approveChannelDefinition
public void approveChannelDefinition(ChannelDefinition channelDef, IPerson approver, Date approveDate) throws Exception(Code)
Sets a channel definition as "approved". This effectively makes a channel definition available in the channel registry, making the channel available for subscription.
Parameters:
  channelDef - the channel definition
Parameters:
  approver - the user that approves this channel definition
Parameters:
  approveDate - the date when the channel definition should be approved (can be future dated)
throws:
  java.lang.Exception -

deleteChannelCategory
public void deleteChannelCategory(ChannelCategory category) throws Exception(Code)
Deletes a channel category.
Parameters:
  category - the channel category to delete
throws:
  java.lang.Exception -

deleteChannelDefinition
public void deleteChannelDefinition(ChannelDefinition channelDef) throws Exception(Code)
Permanently deletes a channel definition from the store.
Parameters:
  channelDef - the channel definition
throws:
  java.lang.Exception -

deleteChannelType
public void deleteChannelType(ChannelType chanType) throws Exception(Code)
Deletes a channel type. The deletion will only succeed if no existing channels reference the channel type.
Parameters:
  chanType - a channel type
throws:
  java.lang.Exception -

disapproveChannelDefinition
public void disapproveChannelDefinition(ChannelDefinition channelDef) throws Exception(Code)
Sets a channel definition as "unapproved". This effectively removes a channel definition from the channel registry, making the channel unavailable for subscription.
Parameters:
  channelDef - the channel definition
throws:
  java.lang.Exception -

getChannelCategory
public ChannelCategory getChannelCategory(String channelCategoryId) throws Exception(Code)
Gets an existing channel category.
Parameters:
  channelCategoryId - the id of the category to get the channel category
throws:
  java.lang.Exception -

getChannelDefinition
public ChannelDefinition getChannelDefinition(int channelPublishId) throws Exception(Code)
Get a channel definition.
Parameters:
  channelPublishId - a channel publish ID a definition of the channel or null if no matching channel definition can be found
throws:
  java.lang.Exception -

getChannelDefinition
public ChannelDefinition getChannelDefinition(String channelFunctionalName) throws Exception(Code)
Get a channel definition. If there is more than one channel definition with the given functional name, then the first one will be returned.
Parameters:
  channelFunctionalName - a channel functional name a definition of the channel or null if no matching channel definition can be found
throws:
  java.lang.Exception -

getChannelDefinitions
public ChannelDefinition[] getChannelDefinitions() throws Exception(Code)
Get all channel definitions including ones that haven't been approved. channelDefs, the channel definitions
throws:
  java.lang.Exception -

getChannelType
public ChannelType getChannelType(int channelTypeId) throws Exception(Code)
Get the channel type associated with a particular identifier.
Parameters:
  channelTypeId - the channel type identifier channelType the channel type
throws:
  java.lang.Exception -

getChannelTypes
public ChannelType[] getChannelTypes() throws Exception(Code)
Returns an array of ChannelTypes. the list of publishable channel types
throws:
  java.lang.Exception -

getChildCategories
public ChannelCategory[] getChildCategories(ChannelCategory parent) throws Exception(Code)
Gets all child channel categories for a parent category. channelCategories the children categories
throws:
  java.lang.Exception -

getChildChannels
public ChannelDefinition[] getChildChannels(ChannelCategory parent) throws Exception(Code)
Gets all child channel definitions for a parent category. channelDefinitions the children channel definitions
throws:
  java.lang.Exception -

getParentCategories
public ChannelCategory[] getParentCategories(ChannelCategory child) throws Exception(Code)
Gets the immediate parent categories of this category. parents, the parent categories.
throws:
  java.lang.Exception -

getParentCategories
public ChannelCategory[] getParentCategories(ChannelDefinition child) throws Exception(Code)
Gets the immediate parent categories of this channel definition. the parent categories.
throws:
  java.lang.Exception -

getTopLevelChannelCategory
public ChannelCategory getTopLevelChannelCategory() throws Exception(Code)
Gets top level channel category the new channel category
throws:
  java.lang.Exception -

newChannelCategory
public ChannelCategory newChannelCategory() throws Exception(Code)
Creates a new channel category. the new channel category
throws:
  java.lang.Exception -

newChannelCategory
public ChannelCategory newChannelCategory(String name, String description, String creatorId) throws Exception(Code)
Creates a new channel category with the specified values.
Parameters:
  name - the name of the category
Parameters:
  description - the name of the description
Parameters:
  creatorId - the id of the creator or system channelCategory the new channel category
throws:
  java.lang.Exception -

newChannelDefinition
public ChannelDefinition newChannelDefinition() throws Exception(Code)
Create a new ChannelDefinition object. the new channel definition
throws:
  java.lang.Exception -

newChannelDefinition
public ChannelDefinition newChannelDefinition(int id) throws Exception(Code)
Create a new ChannelDefinition object.
Parameters:
  id - channel id the new channel definition
throws:
  java.lang.Exception -

newChannelType
public ChannelType newChannelType() throws Exception(Code)
Creates a new channel type. the new channel type
throws:
  java.lang.Exception -

removeCategoryFromCategory
public void removeCategoryFromCategory(ChannelCategory child, ChannelCategory parent) throws Exception(Code)
Makes one category a child of another.
Parameters:
  child - the category to remove
Parameters:
  parent - the category to remove from
throws:
  java.lang.Exception -

removeChannelFromCategory
public void removeChannelFromCategory(ChannelDefinition channelDef, ChannelCategory category) throws Exception(Code)
Disassociates a channel definition from a category.
Parameters:
  channelDef - the channel definition
Parameters:
  category - the channel category from which to disassociate the channel definition
throws:
  java.lang.Exception -

saveChannelCategory
public void saveChannelCategory(ChannelCategory category) throws Exception(Code)
Persists a channel category.
Parameters:
  category - the channel category to persist
throws:
  java.lang.Exception -

saveChannelDefinition
public void saveChannelDefinition(ChannelDefinition channelDef) throws Exception(Code)
Persists a channel definition.
Parameters:
  channelDef - the channel definition
throws:
  java.lang.Exception -

saveChannelType
public void saveChannelType(ChannelType chanType) throws Exception(Code)
Persists a channel type.
Parameters:
  chanType - a channel type
throws:
  java.lang.Exception -

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.