A C D E F G I L O P Q R S T U V

A

addACL(String, String, int, int) - Method in class com.lotus.cs.DominoService

Adds a single ACL to an existing database.

addGroup(String, String, String, int) - Method in class com.lotus.cs.QPService

Adds a group and assigns access rights to a room of a QuickPlace.

addMember(String, String, String, int) - Method in class com.lotus.cs.QPService

Adds a member and assigns access rights to a room of a QuickPlace.

C

CACHE_SERVERLIST - Static variable in class com.lotus.cs.DominoService

CalendarDayInfo - class com.lotus.cs.CalendarDayInfo.

CalendarDayInfo encapsulates a day within a calendar's current time period.

cleanup() - Method in interface com.lotus.cs.CSBaseService

Called when the user is done with the service object (to give the service object an opportunity to clean up resources used).

cleanup() - Method in class com.lotus.cs.DiscoveryServerService

Always call the cleanup() method when finished with the Service object.

cleanup() - Method in class com.lotus.cs.DominoService

Always call the cleanup() method when finished with the Service object.

cleanup() - Method in class com.lotus.cs.PeopleService

Always call the cleanup() method when finished with the Service object.

cleanup() - Method in class com.lotus.cs.QPService

Always call the cleanup() method when finished with the Service object.

ColumnInfo - class com.lotus.cs.ColumnInfo.

ColumnInfo contains information about the columns in a Domino view.

COPYRIGHT - Static variable in interface com.lotus.cs.CSBaseService

copyright statement

COPYRIGHT - Static variable in class com.lotus.cs.CSCredentials

copyright statement

COPYRIGHT - Static variable in class com.lotus.cs.CSEnvironment

copyright statement

COPYRIGHT - Static variable in class com.lotus.cs.CSFactory

copyright statement

COPYRIGHT - Static variable in class com.lotus.cs.CalendarDayInfo

copyright statement

COPYRIGHT - Static variable in class com.lotus.cs.ColumnInfo

copyright statement

COPYRIGHT - Static variable in class com.lotus.cs.DiscoveryServerService

copyright statement

COPYRIGHT - Static variable in class com.lotus.cs.DominoService

copyright statement

COPYRIGHT - Static variable in class com.lotus.cs.EntryInfo

copyright statement

COPYRIGHT - Static variable in class com.lotus.cs.PeopleService

copyright statement

COPYRIGHT - Static variable in class com.lotus.cs.QPService

copyright statement

COPYRIGHT - Static variable in class com.lotus.cs.RowInfo

copyright statement

COPYRIGHT - Static variable in class com.lotus.cs.ViewInfo

copyright statement

create(Hashtable) - Method in class com.lotus.cs.QPService

Creates a QuickPlace on the remote server and returns the URL that references it.

createDatabase(String, String, String) - Method in class com.lotus.cs.DominoService

Creates a new Domino database from a database template.

createDocument(String, HashMap) - Method in class com.lotus.cs.DominoService

Creates a document in the db.

createPlace(String, String, String, HashMap) - Method in class com.lotus.cs.QPService

Creates a QuickPlace on the remote server and returns the URL that references it.

CS_PERF_PROP_USEWMM - Static variable in class com.lotus.cs.CSEnvironment

server type (to be passed to getServers method and other methods with param serverType)

CS_PERSON_DEPARTMENT - Static variable in class com.lotus.cs.PeopleService

Key name returned with the getPersonInfo HashMap

CS_PERSON_DOMINOMAILFILE - Static variable in class com.lotus.cs.PeopleService

Key name returned with the getPersonInfo HashMap

CS_PERSON_DOMINOMAILSERVER - Static variable in class com.lotus.cs.PeopleService

Key name returned with the getPersonInfo HashMap

CS_PERSON_DOMINONAME - Static variable in class com.lotus.cs.PeopleService

Key name returned with the getPersonInfo HashMap

CS_PERSON_EMAIL - Static variable in class com.lotus.cs.PeopleService

Key name returned with the getPersonInfo HashMap

CS_PERSON_FULLNAME - Static variable in class com.lotus.cs.PeopleService

Key name returned with the getPersonInfo HashMap

CS_PERSON_JOBTITLE - Static variable in class com.lotus.cs.PeopleService

Key name returned with the getPersonInfo HashMap

CS_PERSON_LOCATION - Static variable in class com.lotus.cs.PeopleService

Key name returned with the getPersonInfo HashMap

CS_PERSON_PROFILEURL - Static variable in class com.lotus.cs.PeopleService

Key name returned with the getPersonInfo HashMap

CS_PERSON_SUMMARY - Static variable in class com.lotus.cs.PeopleService

Key name returned with the getPersonInfo HashMap

CS_PROP_ENABLED - Static variable in class com.lotus.cs.CSEnvironment

environment property name (used as keys in the server property HashMap argument)

CS_PROP_HOSTNAME - Static variable in class com.lotus.cs.CSEnvironment

environment property name (used as keys in the server property HashMap argument)

CS_PROP_NUMSERVERS - Static variable in class com.lotus.cs.CSEnvironment

environment property name (used as keys in the server property HashMap argument)

CS_PROP_PORT - Static variable in class com.lotus.cs.CSEnvironment

environment property name (used as keys in the server property HashMap argument)

CS_PROP_PROTOCOL - Static variable in class com.lotus.cs.CSEnvironment

environment property name (used as keys in the server property HashMap argument)

CS_PROP_VERSION - Static variable in class com.lotus.cs.CSEnvironment

environment property name (used as keys in the server property HashMap argument)

CS_SERVER_CUSTOM_CRED - Static variable in class com.lotus.cs.CSEnvironment

For customers that use something other than the WPS LPTA mechanism for portal authentication, ie.

CS_SERVER_DISCOVERY_SERVER - Static variable in class com.lotus.cs.CSEnvironment

server type (to be passed to getServers method and other methods with param serverType)

CS_SERVER_DOMINO_DIRECTORY - Static variable in class com.lotus.cs.CSEnvironment

server type (to be passed to getServers method and other methods with param serverType)

CS_SERVER_QUICKPLACE - Static variable in class com.lotus.cs.CSEnvironment

server type (to be passed to getServers method and other methods with param serverType)

CS_SERVER_SAMETIME - Static variable in class com.lotus.cs.CSEnvironment

server type (to be passed to getServers method and other methods with param serverType)

CS_SERVER_WEBSPHERE_PORTAL_EXTEND - Static variable in class com.lotus.cs.CSEnvironment

server type (to be passed to getServers method and other methods with param serverType)

CSBaseService - interface com.lotus.cs.CSBaseService.

All service classes implement the CSBaseService interface.

CSCredentials - class com.lotus.cs.CSCredentials.

CSCredentials is a class used to extract and hold Authentication information.

CSEnvironment - class com.lotus.cs.CSEnvironment.

CSEnvironment is the starting point to instantiate and use Lotus Collaborative Components.

CSFactory - class com.lotus.cs.CSFactory.

The CSFactory object is used to instantiate the Java service objects.

CSFactory() - Constructor for class com.lotus.cs.CSFactory

CSQP_Authors - Static variable in class com.lotus.cs.QPService

CSQP_Managers - Static variable in class com.lotus.cs.QPService

CSQP_Readers - Static variable in class com.lotus.cs.QPService

D

deleteDocument(String, String, String) - Method in class com.lotus.cs.DominoService

Removes a document from the given database

DISCOVERY_SERVER_SERVICE - Static variable in class com.lotus.cs.CSFactory

Collaborative service type (to be passed to the getService method)

DiscoveryServerService - class com.lotus.cs.DiscoveryServerService.

DiscoveryServerService is used to retrieve data from a Discovery Server.

DOMINO_46 - Static variable in class com.lotus.cs.ViewInfo

Domino version (returned by ViewInfo.getVersion)

DOMINO_5PLUS - Static variable in class com.lotus.cs.ViewInfo

Domino version (returned by ViewInfo.getVersion)

DOMINO_SERVICE - Static variable in class com.lotus.cs.CSFactory

Collaborative service type (to be passed to the getService method)

DominoService - class com.lotus.cs.DominoService.

DominoService is used to retrieve data (and, in some cases, write data) from (to) Domino databases.

E

EntryInfo - class com.lotus.cs.EntryInfo.

The EntryInfo encapsulates an entry in a calendar.

F

findDocuments(String, int, int) - Method in class com.lotus.cs.DiscoveryServerService

Returns results from a specified document search.

findPeople(String, int, int) - Method in class com.lotus.cs.DiscoveryServerService

Returns results from a specified people search.

findPlaces(String, int, int) - Method in class com.lotus.cs.DiscoveryServerService

Returns results from a specified place search.

G

getAlt() - Method in class com.lotus.cs.EntryInfo

This method is provided for convenient formatting of a bubble help String for a calendar entry.

getAvailableServers(String) - Static method in class com.lotus.cs.CSEnvironment

This method returns a HashMap containing properties for a specified server type in the environment.

getCalendarDayInfo(String, int) - Method in class com.lotus.cs.ViewInfo

Returns the calendar data, for a specified period of time, relative to a specified ISO standard (yyyy-mm-dd) date.

getColumnInfo() - Method in class com.lotus.cs.ViewInfo

Returns column information about a view, encapsulated in an array of objects of type ColumnInfo.

getCompleteDatabases(String) - Method in class com.lotus.cs.DominoService

Return a complete list of domino database names and or directories on the given server.

getCompleteQuickPlaceComponents(String) - Method in class com.lotus.cs.DominoService

Return a list of QuickPlace components in a QuickPlace.

getCredentials(HttpServletRequest) - Method in class com.lotus.cs.CSEnvironment

This method gets the CSCredentials object which is required to instantiate the service objects.

getCredentials(String, String) - Static method in class com.lotus.cs.CSEnvironment

This method is provided for use only when the credentials in the HttpServletRequest are not valid for the service object you wish to instantiate (unusual circumstance).

getCursor() - Method in class com.lotus.cs.DiscoveryServerService

Returns the specified Discovery Server object.

getDatabases(String, String) - Method in class com.lotus.cs.DominoService

Return a list of domino database names and directory names in the specified start directory.

getDatabaseViews(String) - Method in class com.lotus.cs.DominoService

Return a list of views in a given domino database.

getDatabaseViewsWithAliases(String, boolean, boolean) - Method in class com.lotus.cs.DominoService

Return a list of views in a given domino database.

getDate() - Method in class com.lotus.cs.CalendarDayInfo

Returns a Java Calendar object for the day.

getDistinguishedName(String) - Method in class com.lotus.cs.DominoService

Returns the distinguished name of the user.

getDocsCreatedByUser(String, String, int, int) - Method in class com.lotus.cs.DiscoveryServerService

Returns information about the set of documents created by the specified user.

getDocumentInfo(String, String, String, String[]) - Method in class com.lotus.cs.DominoService

Returns values for fields in a document which are of type String.

getDominoName(String) - Method in class com.lotus.cs.DominoService

Converts a distinguished name into a Domino name (also referred to as the Abbreviated name) For example, "OU=CAM,O=Lotus" will be converted to "/CAM/Lotus" Note that this is simply a helper method - there is no LDAP query made.

getDSControlCenterURL() - Method in class com.lotus.cs.DiscoveryServerService

Returns the URL to the Discovery Control Center UI.

getEditURL(String, String, String, boolean) - Method in class com.lotus.cs.DominoService

Returns a URL to the specified document.

getEmailAddress(String) - Method in class com.lotus.cs.DominoService

Returns the email address of the user.

getEntryInfo() - Method in class com.lotus.cs.CalendarDayInfo

Returns the set of entries for the day.

getEnvironment(HttpServletRequest) - Static method in class com.lotus.cs.CSEnvironment

This method gets the CSEnvironment - this is the starting point to use Lotus Collaborative Services.

getFTSearch() - Method in class com.lotus.cs.DiscoveryServerService

Returns the specified Discovery Server object.

getIconName() - Method in class com.lotus.cs.EntryInfo

Returns the name of the gif image which should be displayed with this entry.

getIndentLevel() - Method in class com.lotus.cs.RowInfo

Returns the zero-based index level of the row (relevant in hierarchical or categorized views only).

getISODate() - Method in class com.lotus.cs.CalendarDayInfo

Returns a String representation for the day's date.

getKMapURL_DS11(String) - Static method in class com.lotus.cs.DiscoveryServerService

Returns the URL to the Discovery Server1.1 K-map UI.

getKMapURL() - Method in class com.lotus.cs.DiscoveryServerService

Returns the URL to the Discovery Server K-map UI.

getKMapURL(String) - Method in class com.lotus.cs.DiscoveryServerService

Returns the URL to the Discovery Server K-map UI for the requested category.

getMailServerFile(String) - Method in class com.lotus.cs.DominoService

Returns the names of the Domino mail file and mail server for a valid user in the domain.

getMemberAccess(String, String) - Method in class com.lotus.cs.QPService

Returns the distinguished names and access rights of all members and groups to a room of a QuickPlace.

getMetrics() - Method in class com.lotus.cs.DiscoveryServerService

Returns the specified Discovery Server object.

getNextISODate(int) - Method in class com.lotus.cs.CalendarDayInfo

Returns a String representation for the next day's date.

getOpenURL(String, String, String, boolean) - Method in class com.lotus.cs.DominoService

Returns a URL to the specified document.

getPersonInfo(String) - Method in class com.lotus.cs.PeopleService

Returns information about a specified person.

getPlaces() - Method in class com.lotus.cs.QPService

Retrieves a list of placetypes that are available on this server with their descriptions..

getPlacesForMember(String) - Method in class com.lotus.cs.QPService

Return a list of places the authenticated user is a member of on all QuickPlace servers in the QuickPlace service.

getPlaceTypes() - Method in class com.lotus.cs.QPService

Retrieves a HashMap of placetypes that are available on this server, with their descriptions.

getPositionString() - Method in class com.lotus.cs.RowInfo

Returns the position String for the row.

getPreviousISODate(int) - Method in class com.lotus.cs.CalendarDayInfo

Returns a String representation for the previous day's date.

getProfileURL_DS11(String, String) - Static method in class com.lotus.cs.DiscoveryServerService

Returns the URL to the profile for a specified user in Discovery Server version 1.1 .

getProfileURL_DS20(String, String) - Static method in class com.lotus.cs.DiscoveryServerService

Returns the URL to the profile for a specified user in Discovery Server version 2.0 .

getProfileURL(String) - Method in class com.lotus.cs.DiscoveryServerService

Returns the URL to the profile for a specified user.

getProtocol() - Method in class com.lotus.cs.ViewInfo

Returns "http" or "https", depending on whether SSL is enabled for the data source.

getQuickPlaceComponents(String) - Method in class com.lotus.cs.DominoService

Return a list of QuickPlace components in a QuickPlace.

getQuickPlaceDatabases() - Method in class com.lotus.cs.DominoService

Returns the list of QuickPlace databases.

getRepository() - Method in class com.lotus.cs.DiscoveryServerService

Returns the specified Discovery Server object.

getRepositoryInfo() - Method in class com.lotus.cs.DiscoveryServerService

Returns the specified Discovery Server object.

getResources(HttpServletRequest) - Method in class com.lotus.cs.CSEnvironment

This method returns the resources contained in the CSRes properties file (uses locale).

getRoomStructure(String, String) - Method in class com.lotus.cs.QPService

Returns the room hierachy of a QuickPlace and the table of contents for each room.

getRowInfo(String, int) - Method in class com.lotus.cs.ViewInfo

Returns row information about a view, encapsulated in an array of objects of type RowInfo.

getServers() - Method in class com.lotus.cs.DominoService

Returns a list of domino servers in the domain which have the http-hostname attribute set.

getService(CSCredentials, String) - Static method in class com.lotus.cs.CSFactory

Use this version of getService when you wish to use the Lotus Collaborative servers which are configured in the environment.

getService(CSCredentials, String, String, String) - Static method in class com.lotus.cs.CSFactory

Use this version when you wish to specify the Lotus server to connect to (or if you wish to over-ride the servers which are configured in the environment).

getSessionObject() - Method in class com.lotus.cs.DominoService

Returns the Domino Java API Session object.

getSummary() - Method in class com.lotus.cs.EntryInfo

This method is provided for convenient formatting of the values returned by getValues.

getTaxEdit() - Method in class com.lotus.cs.DiscoveryServerService

Returns the specified Discovery Server object.

getTaxonomyData() - Method in class com.lotus.cs.DiscoveryServerService

Returns the specified Discovery Server object.

getTitle() - Method in class com.lotus.cs.ColumnInfo

Returns the title of the column.

getUNID() - Method in class com.lotus.cs.EntryInfo

Returns the universal ID of the document associated with this entry.

getUNID() - Method in class com.lotus.cs.RowInfo

Returns the universal ID of the document associated with this row.

getUserLoginName() - Method in class com.lotus.cs.CSCredentials

Returns the login name for the currently logged in user.

getUserName() - Method in class com.lotus.cs.CSCredentials

Returns a string representing the user name in Distinguished Name format.

getValues() - Method in class com.lotus.cs.EntryInfo

Returns a String array representing the values for the entry.

getValues() - Method in class com.lotus.cs.RowInfo

Returns a String array representing the column values for the row.

getVersion() - Method in class com.lotus.cs.ViewInfo

Returns the Domino version (simplified) of the data source server.

getViewCategories() - Method in class com.lotus.cs.ViewInfo

Returns the list of categories in a specified view.

getViewInfo(String, String) - Method in class com.lotus.cs.DominoService

Returns view information about a view, encapsulated in a ViewInfo object.

getWidthPercentage() - Method in class com.lotus.cs.ColumnInfo

Returns the width percentage of this column in the view (the column percentages returned add up to 100).

getWorkQueueReader(String) - Method in class com.lotus.cs.DiscoveryServerService

Returns the specified Discovery Server object.

getWorkQueueWriter(String, KDSWorkQueueAction, int) - Method in class com.lotus.cs.DiscoveryServerService

Returns the specified Discovery Server object.

I

init(CSCredentials, String, String) - Method in interface com.lotus.cs.CSBaseService

Initializes the service class with credentials and server configuration information.

init(CSCredentials, String, String) - Method in class com.lotus.cs.DiscoveryServerService

Do not call the init() method.

init(CSCredentials, String, String) - Method in class com.lotus.cs.DominoService

Do not call the init() method.

init(CSCredentials, String, String) - Method in class com.lotus.cs.PeopleService

Do not call the init() method.

init(CSCredentials, String, String) - Method in class com.lotus.cs.QPService

Do not call the init() method.

isCalendarView() - Method in class com.lotus.cs.ViewInfo

Returns 1 if the view is a calendar view, 0 if the view is not a calendar view, and -1 if this information can not be determined.

isCategory() - Method in class com.lotus.cs.ColumnInfo

Returns whether or not this column is a category view.

isIcon() - Method in class com.lotus.cs.ColumnInfo

Returns whether or not the data is this column is icon data.

isInTodaysMonth() - Method in class com.lotus.cs.CalendarDayInfo

Returns whether or not the day is in the current month.

isServerAvailable(String) - Static method in class com.lotus.cs.CSEnvironment

This method returns a boolean indicating whether or not the specified server type is available in the environment.

isShowTwistie() - Method in class com.lotus.cs.ColumnInfo

Returns whether or not this column has the possibility of needing a twistie.

isToday() - Method in class com.lotus.cs.CalendarDayInfo

Returns whether or not the day is the current day.

L

lockPlace(String, String) - Method in class com.lotus.cs.QPService

Locks the specified QuickPlace.

O

ONE_DAY - Static variable in class com.lotus.cs.ViewInfo

Calendar grid value (used with ViewInfo.getCalendarDayInfo)

ONE_MONTH - Static variable in class com.lotus.cs.ViewInfo

Calendar grid value (used with ViewInfo.getCalendarDayInfo)

ONE_WEEK - Static variable in class com.lotus.cs.ViewInfo

Calendar grid value (used with ViewInfo.getCalendarDayInfo)

P

PeopleService - class com.lotus.cs.PeopleService.

PeopleService is an aggregation of all the information which Collaborative Components can retrieve about a person.

PERSON_SERVICE - Static variable in class com.lotus.cs.CSFactory

Collaborative service type (to be passed to the getService method)

Q

QPService - class com.lotus.cs.QPService.

An instance of class QPService creates 1-n instances of quickplaces on a specific server.

QUICKPLACE_SERVICE - Static variable in class com.lotus.cs.CSFactory

Collaborative service type (to be passed to the getService method)

R

removeGroup(String, String, String, boolean) - Method in class com.lotus.cs.QPService

Removes a group from a room of a QuickPlace.

removeMember(String, String, String, boolean) - Method in class com.lotus.cs.QPService

Removes a member from a room of a QuickPlace.

removePlace(String, boolean) - Method in class com.lotus.cs.QPService

Removes the entire QuickPlace from the server.

RowInfo - class com.lotus.cs.RowInfo.

RowInfo contains information about the rows in a Domino view (non-Calendar view).

S

SAMETIME_SERVICE - Static variable in class com.lotus.cs.CSFactory

Collaborative service type (to be passed to the getService method)

search(String, int, int, String) - Method in class com.lotus.cs.QPService

Performs a "full-text" search across all QuickPlaces in the QuickPlace service.

setPreformat(boolean) - Method in class com.lotus.cs.ViewInfo

Used to contol if values are to be preformatted.

T

TWO_DAYS - Static variable in class com.lotus.cs.ViewInfo

Calendar grid value (used with ViewInfo.getCalendarDayInfo)

TWO_WEEKS - Static variable in class com.lotus.cs.ViewInfo

Calendar grid value (used with ViewInfo.getCalendarDayInfo)

U

unlockPlace(String) - Method in class com.lotus.cs.QPService

Unlocks the specified QuickPlace.

updateDocument(String, String, String, HashMap) - Method in class com.lotus.cs.DominoService

Updates a document in the db.

updateMetaData(String, String, HashMap) - Method in class com.lotus.cs.QPService

Updates the QuickPlace title and the meta data associated with the place, passed in as name value pairs.

useTwistie() - Method in class com.lotus.cs.RowInfo

Returns whether or not the document is a parent document and, therefore, should be presented with a twistie next to it.

V

ViewInfo - class com.lotus.cs.ViewInfo.

A ViewInfo object is the first object to create in order to retrieve data from a Domino view (for all types of views including calendar views).

A C D E F G I L O P Q R S T U V