Oracle® Calendar SDK Java API Reference
10g Release 1 (10.1.2)

B25487-01


oracle.calendar.sdk
Class RequestResult

java.lang.Object
  extended byoracle.calendar.sdk.RequestResult


public class RequestResult
extends java.lang.Object

Nested Class Summary
class RequestResult.ParseError
class RequestResult.Result

Constructor Summary
RequestResult()

Method Summary
void dispose()
Disposes of all the results in in_requestResult.
protected void finalize()
Disposes of all the results in in_requestResult.
RequestResult.Result getFirstFailure()
Returns the first failure obtained from the function from which in_requestResult was returned.
RequestResult.ParseError getFirstParseError()
Returns the first parsing error obtained from a request result.
RequestResult.Result getFirstResult()
Returns the first result obtained from the function from which in_requestResult was returned.
RequestResult.Result getNextFailure()
Returns the next failure contained in a CSDKRequestResult.
RequestResult.ParseError getNextParseError()
Returns the next parsing error obtained from a request result.
RequestResult.Result getNextResult()
Returns the next result contained in a CSDKRequestResult.
java.lang.String toString()

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RequestResult

public RequestResult()

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable
Disposes of all the results in in_requestResult.
Throws:
java.lang.Throwable

dispose

public void dispose()
             throws java.lang.Throwable
Disposes of all the results in in_requestResult.
Throws:
java.lang.Throwable

getFirstResult

public RequestResult.Result getFirstResult()
                                    throws Api.StatusException
Returns the first result obtained from the function from which in_requestResult was returned.

A result is either a failure or a success. A failure is a result which has a status other than CAPI_STAT_OK.

Note: A request result contains the reference to the "current" result, so only one thread should extract result from a given request result at a time.

Returns:
Result Contains the user and uid of the agenda and calendar object being acted on, and the status code returned from that operation
Throws:
Api.StatusException

getFirstFailure

public RequestResult.Result getFirstFailure()
                                     throws Api.StatusException
Returns the first failure obtained from the function from which in_requestResult was returned.

A failure is a result which has a status other than CAPI_STAT_OK.

Note: A request result contains the reference to the "current" failure, so only one thread should extract failures from a given request result at a time.

Returns:
Result Contains the user and uid of the agenda and calendar object being acted on, and the status code returned from that operation
Throws:
Api.StatusException

getNextResult

public RequestResult.Result getNextResult()
                                   throws Api.StatusException
Returns the next result contained in a CSDKRequestResult. A call to CSDK_GetFirstResult must precede this call.

Note: A request result contains the reference to the "current" result, so only one thread should extract result from a given request result at a time.

Returns:
Result Contains the user and uid of the agenda and calendar object being acted on, and the status code returned from that operation.
Throws:
Api.StatusException

getNextFailure

public RequestResult.Result getNextFailure()
                                    throws Api.StatusException
Returns the next failure contained in a CSDKRequestResult. A call to CSDK_GetFirstFailure must precede this call.

Note: A request result contains the reference to the "current" failure, so only one thread should extract failures from a given request result at a time.

Returns:
Result Contains the user and uid of the agenda and calendar object being acted on, and the status code returned from that operation
Throws:
Api.StatusException

getFirstParseError

public RequestResult.ParseError getFirstParseError()
                                            throws Api.StatusException
Returns the first parsing error obtained from a request result. A parse error can be generated by any of the CSDK_Store* functions as they attempt to interpret incoming iCalendar or vCard.

Note: A request result contains the reference to the "current" parse error, so only one thread should extract parse errors from a given request result at a time.

A pointer to a copy of the data stream is returned through out_errorBuffer, and a pointer to the parse error location in the buffer is returned via out_errorLocation. Both pointers are valid only until the request result is destroyed.

Returns:
ParseError Contains the offending text, an additional error message if applicable, and the status code generated by the parse error
Throws:
Api.StatusException

getNextParseError

public RequestResult.ParseError getNextParseError()
                                           throws Api.StatusException
Returns the next parsing error obtained from a request result. A call to CSDK_GetFirstParseError must precede this call.

Note: A request result contains the reference to the "current" parse error, so only one thread should extract parse errors from a given request result at a time.

A pointer to a copy of the data stream is returned through out_errorBuffer, and a pointer to the parse error location in the buffer is returned via out_errorLocation. Both pointers are valid only until the request result is destroyed.

Returns:
ParseError Contains the offending text, an additional error message if applicable, and the status code generated by the parse error
Throws:
Api.StatusException

toString

public java.lang.String toString()

Oracle® Calendar SDK Java API Reference
10g Release 1 (10.1.2)

B25487-01


Copyright © 1998, 2005, Oracle. All rights reserved.