com.starteam
Class CheckoutManager.WebCacheCheckoutManager

java.lang.Object
  com.starteam.CheckoutManager.WebCacheCheckoutManager

Enclosing class:

CheckoutManager

public static final class CheckoutManager.WebCacheCheckoutManager
extends java.lang.Object

Method Summary

void	addCheckoutListener(WebCacheCheckoutListener listener) Adds a listener for checkout-related events.
boolean	canCommit() return true if this checkin can be committed
void	checkoutTo(File.WebCacheFile starTeamFile, java.io.File diskFile) Set up a file to checkout to a working file on disk Creates a copy of the global options.
void	checkoutTo(File.WebCacheFile starTeamFile, java.io.OutputStream stream) Set up a file to checkout to an output stream.
File.WebCacheFile[]	commit() commit the changes
CheckoutOptions.WebCacheCheckoutOptions	getOptions() Return the options associated with this checkin manager These options can be changed by the caller on demand
View.WebCacheView	getView() returns the containing view

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addCheckoutListener

public void addCheckoutListener(WebCacheCheckoutListener listener)

Adds a listener for checkout-related events.

Parameters:

listener - Application-specific event handler for checkout-related events.

See Also:

WebCacheCheckoutListener, WebCacheCheckoutEvent

getOptions

public CheckoutOptions.WebCacheCheckoutOptions getOptions()

Return the options associated with this checkin manager These options can be changed by the caller on demand

Returns:

the options associated with this checkin manager

getView

public View.WebCacheView getView()

returns the containing view

Returns:

the View

checkoutTo

public void checkoutTo(File.WebCacheFile starTeamFile,
                       java.io.File diskFile)

Set up a file to checkout to a working file on disk Creates a copy of the global options. Subsequent changes to global options do not affect this file

Parameters:

starTeamFile - a starTeam File Object instance

diskFile - the java.io.File to checkout to

checkoutTo

public void checkoutTo(File.WebCacheFile starTeamFile,
                       java.io.OutputStream stream)

Set up a file to checkout to an output stream. No status update is performed in this case. Creates a copy of the global options. Subsequent changes to global options do not affect this file

Parameters:

starTeamFile - The file to be checked out.

stream - The stream to which the checked out content is written.

canCommit

public boolean canCommit()

return true if this checkin can be committed

Returns:

true if this checkin can be committed

commit

public File.WebCacheFile[] commit()

commit the changes