wt.vc.sessioniteration
Interface SessionIterationService

All Known Implementing Classes:

SessionIterationServiceFwd, StandardSessionIterationService

public interface SessionIterationService

Supported API: true

Extendable: false

Method Summary

SessionEditedIteration	commitSessionIteration(SessionEditedIteration sessionIteration, String comment) Commits the session iteration.
SessionEditedIteration	createSessionIteration(SessionEditedIteration iteration, WTPrincipal principal, String comment) Creates a session iteration for the specified principal from the given iteration.
SessionEditedIteration	deleteSessionIteration(SessionEditedIteration sessionIteration) Deletes the session iteration.
SessionEditedIteration	getSessionIteration(SessionEditedIteration iteration, WTPrincipal principal) Returns a session iteration for the principal specified (or the current principal if null is passed in) -- if one exists -- that was created from the iteration provided.
void	validateCommitSessionIteration(SessionEditedIteration sessionIteration) Returns true if the session iteration can be commited.
void	validateCreateSessionIteration(SessionEditedIteration iteration, WTPrincipal principal) Returns true if the principal can create a session iteration from the specified iteration.
void	validateDeleteSessionIteration(SessionEditedIteration sessionIteration) Validates that the session iteration can be deleted.

Method Detail

getSessionIteration

public SessionEditedIteration getSessionIteration(SessionEditedIteration iteration,
                                                  WTPrincipal principal)
                                           throws WTException

Returns a session iteration for the principal specified (or the current principal if null is passed in) -- if one exists -- that was created from the iteration provided.

Supported API: true

Parameters:

iteration -

principal -

Returns:

SessionEditedIteration

Throws:

WTException

validateCreateSessionIteration

public void validateCreateSessionIteration(SessionEditedIteration iteration,
                                           WTPrincipal principal)
                                    throws WTException

Returns true if the principal can create a session iteration from the specified iteration. Creating a session iteration is analogous to a checkout, except that the "check out" is not reserved.

Supported API: true

Parameters:

iteration -

principal -

Throws:

WTException

createSessionIteration

public SessionEditedIteration createSessionIteration(SessionEditedIteration iteration,
                                                     WTPrincipal principal,
                                                     String comment)
                                              throws WTException

Creates a session iteration for the specified principal from the given iteration. This is analogous to a check out, except that the "check out" is not reserved.

Supported API: true

Parameters:

iteration -

principal -

comment -

Returns:

SessionEditedIteration

Throws:

WTException

validateCommitSessionIteration

public void validateCommitSessionIteration(SessionEditedIteration sessionIteration)
                                    throws WTException

Returns true if the session iteration can be commited. Among the validations is a check to verify that the iteration the session iteration was created from hasn't already been superseded by another user. Committing a session iteration is analogous to a check in.

Supported API: true

Parameters:

sessionIteration -

Throws:

WTException

commitSessionIteration

public SessionEditedIteration commitSessionIteration(SessionEditedIteration sessionIteration,
                                                     String comment)
                                              throws WTException

Commits the session iteration. This is analogous to a check in.

Supported API: true

Parameters:

sessionIteration -

comment -

Returns:

SessionEditedIteration

Throws:

WTException

validateDeleteSessionIteration

public void validateDeleteSessionIteration(SessionEditedIteration sessionIteration)
                                    throws WTException

Validates that the session iteration can be deleted. Deleting a session iteration is analogous to an undo checkout.

Supported API: true

Parameters:

sessionIteration -

Throws:

WTException

deleteSessionIteration

public SessionEditedIteration deleteSessionIteration(SessionEditedIteration sessionIteration)
                                              throws WTException

Deletes the session iteration. This is analogous to an undo checkout.

Supported API: true

Parameters:

sessionIteration -

Returns:

SessionEditedIteration

Throws:

WTException