oracle.calendar.sdk
Class Handle
java.lang.Object
oracle.calendar.sdk.Handle
- public class Handle
- extends java.lang.Object
Method Summary |
void |
dispose()
Destroys one handle. |
protected void |
finalize()
Destroys one handle. |
java.lang.String |
getEmail()
Returns information about the agenda of the supplied handle. |
java.lang.String |
getName()
Returns information about the agenda of the supplied handle. |
java.lang.String |
getType()
Returns information about the agenda of the supplied handle. |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Handle
public Handle()
finalize
protected void finalize()
throws java.lang.Throwable
- Destroys one handle.
-
- Throws:
java.lang.Throwable
dispose
public void dispose()
throws java.lang.Throwable
- Destroys one handle.
-
- Throws:
java.lang.Throwable
getName
public java.lang.String getName()
throws Api.StatusException
- Returns information about the agenda of the supplied handle.
Three pieces of information can be returned, chosen by the value of in_flags. The information is returned as a pointer to a static read-only string.
The following are the types of information that can be returned:
- CAPI_HANDLE_TYPE indicates the type of the handle. This can be "user" or "resource" and indicates what type of agenda this is.
- CAPI_HANDLE_NAME returns the name of the agenda owner, or resource, in the form of a sequence of field-value pairs, separated by "/". This string, when prepended with a '?' is of an appropriate format to be passed to CSDK_GetHandle. A description of this format is given in "User identification" section of this manual.
- CAPI_HANDLE_MAILTO returns the email address of who the agenda belongs to. Since not all users (and no resources) will have e-mail addresses set on the calendar server, an error (CAPI_STAT_DATA_EMAIL_NOTSET) will be returned when no e-mail address is set.
-
- Returns:
- String String containing the information requested
- Throws:
Api.StatusException
getEmail
public java.lang.String getEmail()
throws Api.StatusException
- Returns information about the agenda of the supplied handle.
Three pieces of information can be returned, chosen by the value of in_flags. The information is returned as a pointer to a static read-only string.
The following are the types of information that can be returned:
- CAPI_HANDLE_TYPE indicates the type of the handle. This can be "user" or "resource" and indicates what type of agenda this is.
- CAPI_HANDLE_NAME returns the name of the agenda owner, or resource, in the form of a sequence of field-value pairs, separated by "/". This string, when prepended with a '?' is of an appropriate format to be passed to CSDK_GetHandle. A description of this format is given in "User identification" section of this manual.
- CAPI_HANDLE_MAILTO returns the email address of who the agenda belongs to. Since not all users (and no resources) will have e-mail addresses set on the calendar server, an error (CAPI_STAT_DATA_EMAIL_NOTSET) will be returned when no e-mail address is set.
-
- Returns:
- String String containing the information requested
- Throws:
Api.StatusException
getType
public java.lang.String getType()
throws Api.StatusException
- Returns information about the agenda of the supplied handle.
Three pieces of information can be returned, chosen by the value of in_flags. The information is returned as a pointer to a static read-only string.
The following are the types of information that can be returned:
- CAPI_HANDLE_TYPE indicates the type of the handle. This can be "user" or "resource" and indicates what type of agenda this is.
- CAPI_HANDLE_NAME returns the name of the agenda owner, or resource, in the form of a sequence of field-value pairs, separated by "/". This string, when prepended with a '?' is of an appropriate format to be passed to CSDK_GetHandle. A description of this format is given in "User identification" section of this manual.
- CAPI_HANDLE_MAILTO returns the email address of who the agenda belongs to. Since not all users (and no resources) will have e-mail addresses set on the calendar server, an error (CAPI_STAT_DATA_EMAIL_NOTSET) will be returned when no e-mail address is set.
-
- Returns:
- String String containing the information requested
- Throws:
Api.StatusException
Copyright © 1998, 2005, Oracle. All rights reserved.