com.sapportals.wcm.repository.service.statemanagement

Interface ITransition


Deprecated. as of EP5 SP4 all state management related classes will become resource-dependent. Please use IResourceTransition instead.

public interface ITransition

A transition handles everything needed for a document to go from one state to another. It defines which state is reached from another specific state and it defines whether the transition is permitted for a specific resource or for a list of resources.


Method Summary
 boolean execute(IResource aResource)
          Deprecated. Executes the transition
 String getDescription(Locale aLocale)
          Deprecated. Gets a description for the transition
 String getID()
          Deprecated. Gets the ID of the transition
 String getSuccessMessage(Locale aLocale)
          Deprecated. Gets a sucess message for the transition
 boolean isAllowed(IResource aResource)
          Deprecated. Check whether the transition is allowed for a resource
 boolean isAllowed(IResourceList aResourceList)
          Deprecated. Checks that the transition is allowed for a list of resources
 

Method Detail

getID

public String getID()
Deprecated. 
Gets the ID of the transition

Returns:
the ID value

execute

public boolean execute(IResource aResource)
                throws WcmException
Deprecated. 
Executes the transition

Parameters:
aResource - the resource for which the transition is to be executed
Returns:
true if execution was successful
Throws:
WcmException - exception raised in failure situation

getDescription

public String getDescription(Locale aLocale)
Deprecated. 
Gets a description for the transition

Parameters:
aLocale - the locale to use
Returns:
the description value

getSuccessMessage

public String getSuccessMessage(Locale aLocale)
Deprecated. 
Gets a sucess message for the transition

Parameters:
aLocale - the locale to use
Returns:
the SuccessMessage value

isAllowed

public boolean isAllowed(IResource aResource)
                  throws WcmException
Deprecated. 
Check whether the transition is allowed for a resource

Parameters:
aResource - resource to check
Returns:
true if transition is allowed
Throws:
WcmException

isAllowed

public boolean isAllowed(IResourceList aResourceList)
                  throws WcmException
Deprecated. 
Checks that the transition is allowed for a list of resources

Parameters:
aResourceList - resourcelist to check
Returns:
true if transition is permitted for all resources in the list
Throws:
WcmException


Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.