Java Doc for CitationService.java in » ERP-CRM-Financial » sakai » org » sakaiproject » citation » api » 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 » ERP CRM Financial » sakai » org.sakaiproject.citation.api

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.sakaiproject.citation.api .CitationService

All known Subclasses:   org.sakaiproject.citation.impl .BaseCitationService,
CitationService
public interface CitationService extends EntityProducer(Code)

Field Summary
final public static String APPLICATION_ID
     The type string for this application: should not change over time as it may be stored in various parts of persistent entities.
final public static String CITATION_LIST_ID

final public static int DEFAULT_PAGE_SIZE

final public static String HELPER_ID

final public static String PROP_ALTERNATE_REFERENCE
     Property name on a Citation that will cause getUrl() and getRefernce() to return an alternal root reference.
final public static String PROP_TEMPORARY_CITATION_LIST

final public static String REFERENCE_ROOT
     This string starts the references to entities in this service.
final public static String REF_TYPE_EXPORT_RIS_ALL

final public static String REF_TYPE_EXPORT_RIS_SEL

final public static String REF_TYPE_VIEW_LIST

final public static String RIS_FORMAT

final public static String SERVICE_NAME
     This string can be used to find the service in the service manager.
final public static String UNKNOWN_TYPE


Method Summary
public Citation addCitation(String mediatype)

public CitationCollection addCollection()

public boolean allowAddCitationList(String contentCollectionId)
     Checks permissions to add a CitationList.
public boolean allowRemoveCitationList(String contentResourceId)

public boolean allowReviseCitationList(String contentResourceId)
     Checks permission to revise a CitationList, including permissions to add, remove or revise citations within the CitationList.
public CitationCollection copyAll(String collectionId)

public CitationCollection getCollection(String collectionId)

public Schema getDefaultSchema()

public Schema getSchema(String name)

public List getSchemas()

public Citation getTemporaryCitation()
     Create a temporary citation that has not been saved in storage.
public Citation getTemporaryCitation(Asset asset)
     Create a temporary citation to represent an asset.
public CitationCollection getTemporaryCollection()

public Set getValidPropertyNames()

public boolean isMultivalued(String schemaId, String fieldId)

public List listSchemas()

public void removeCollection(CitationCollection edit)
     This method permanently removes a CitationCollection and all Citations it contains.
public void save(Citation citation)

public void save(CitationCollection collection)


Field Detail
APPLICATION_ID
final public static String APPLICATION_ID(Code)
The type string for this application: should not change over time as it may be stored in various parts of persistent entities.

CITATION_LIST_ID
final public static String CITATION_LIST_ID(Code)

DEFAULT_PAGE_SIZE
final public static int DEFAULT_PAGE_SIZE(Code)

HELPER_ID
final public static String HELPER_ID(Code)

PROP_ALTERNATE_REFERENCE
final public static String PROP_ALTERNATE_REFERENCE(Code)
Property name on a Citation that will cause getUrl() and getRefernce() to return an alternal root reference.

PROP_TEMPORARY_CITATION_LIST
final public static String PROP_TEMPORARY_CITATION_LIST(Code)

REFERENCE_ROOT
final public static String REFERENCE_ROOT(Code)
This string starts the references to entities in this service.

REF_TYPE_EXPORT_RIS_ALL
final public static String REF_TYPE_EXPORT_RIS_ALL(Code)

REF_TYPE_EXPORT_RIS_SEL
final public static String REF_TYPE_EXPORT_RIS_SEL(Code)

REF_TYPE_VIEW_LIST
final public static String REF_TYPE_VIEW_LIST(Code)

RIS_FORMAT
final public static String RIS_FORMAT(Code)

SERVICE_NAME
final public static String SERVICE_NAME(Code)
This string can be used to find the service in the service manager.

UNKNOWN_TYPE
final public static String UNKNOWN_TYPE(Code)

Method Detail
addCitation
public Citation addCitation(String mediatype)(Code)

Parameters:
  listId -

addCollection
public CitationCollection addCollection()(Code)

allowAddCitationList
public boolean allowAddCitationList(String contentCollectionId)(Code)
Checks permissions to add a CitationList. Returns true if the user has permission to add a resource in the collection identified by the parameter.
Parameters:
  contentCollectionId -

allowRemoveCitationList
public boolean allowRemoveCitationList(String contentResourceId)(Code)

allowReviseCitationList
public boolean allowReviseCitationList(String contentResourceId)(Code)
Checks permission to revise a CitationList, including permissions to add, remove or revise citations within the CitationList. Returns true if the user has permission to revise the resource identified by the parameter. Also returns true if all of these conditions are met: (1) the user is the creator of the specified resource, (2) the specified resource is a temporary CitationList (as identified by the value of the PROP_TEMPORARY_CITATION_LIST property), and (3) the user has permission to add resources in the collection containing the resource.
Parameters:
  contentResourceId -

copyAll
public CitationCollection copyAll(String collectionId)(Code)

Parameters:
  collectionId -

getCollection
public CitationCollection getCollection(String collectionId) throws IdUnusedException(Code)

getDefaultSchema
public Schema getDefaultSchema()(Code)
Access the default schema The default schema, or null if no schema has been set as the default.

getSchema
public Schema getSchema(String name)(Code)
Access a schema by its name
Parameters:
  name - The name of the schema The schema, or null if no schema has been defined with that name.

getSchemas
public List getSchemas()(Code)
Access a list of all schemas that have been defined A list of Schema objects representing the schemas that have been defined.

getTemporaryCitation
public Citation getTemporaryCitation()(Code)
Create a temporary citation that has not been saved in storage. Saving it or saving a collection it's a member of will convert it to a permanent citation and save it in storage.

getTemporaryCitation
public Citation getTemporaryCitation(Asset asset)(Code)
Create a temporary citation to represent an asset. The new citation will not have been saved in storage yet. Saving it or saving a collection it's a member of will convert it to a permanent citation and save it in storage.
Parameters:
  asset -

getTemporaryCollection
public CitationCollection getTemporaryCollection()(Code)

getValidPropertyNames
public Set getValidPropertyNames()(Code)

isMultivalued
public boolean isMultivalued(String schemaId, String fieldId)(Code)

Parameters:
  schemaId -
Parameters:
  fieldId -

listSchemas
public List listSchemas()(Code)
Access a list of identifiers for all schemas that have been defined A list of Strings representing the names of schemas that have been defined.

removeCollection
public void removeCollection(CitationCollection edit)(Code)
This method permanently removes a CitationCollection and all Citations it contains.
Parameters:
  edit - The CitationCollection to remove.

save
public void save(Citation citation)(Code)

Parameters:
  citation -

save
public void save(CitationCollection collection)(Code)

Parameters:
  collection -

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.