com.sapportals.wcm.repository.service.statemanagement

Interface IResourceTransitionList

All Superinterfaces:
IList

public interface IResourceTransitionList
extends IList

A special list containing only ResourceTransition instances. All methods of the java.util.List are provided.


Method Summary
 void add(int index, IResourceTransition element)
          Inserts the specified element at the specified position in this list (optional operation).
 boolean add(IResourceTransition o)
          Appends the specified element to the end of this list (optional operation) Depending on the runtime type of the contained list, this operation may place limitations on what elements can be added to this list.
 boolean addAll(IResourceTransitionList c)
          Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation).
 IResourceTransition get(int index)
          Returns the element at the specified position in this list
 IResourceTransitionIterator iterator()
          Returns an iterator over the elements in this list in proper sequence
 IResourceTransitionIterator listIterator()
          Returns a list iterator of the elements in this list (in proper sequence)
 IResourceTransitionIterator listIterator(int index)
          Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list.
 IResourceTransition remove(int index)
          Inserts the specified element at the specified position in this list (optional operation).
 IResourceTransition set(int index, IResourceTransition element)
          Replaces the element at the specified position in this list with the specified element (optional operation)
 IResourceTransitionList subList(int fromIndex, int toIndex)
          Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list.
 IResourceTransition[] toArray()
          Returns an array containing all of the elements in this list in proper sequence.
 IResourceTransition[] toArray(IResourceTransition[] a)
          Returns an array containing all of the elements in this list in proper sequence; the runtime type of the returned array is that of the specified array.
 
Methods inherited from interface com.sapportals.wcm.repository.service.statemanagement.IList
clear, contains, containsAll, equals, hashCode, indexOf, isEmpty, lastIndexOf, remove, removeAll, retainAll, size
 

Method Detail

iterator

IResourceTransitionIterator iterator()
                                     throws com.sapportals.wcm.WcmException
Returns an iterator over the elements in this list in proper sequence

Returns:
an iterator over the elements in this list in proper sequence
Throws:
com.sapportals.wcm.WcmException

toArray

IResourceTransition[] toArray()
Returns an array containing all of the elements in this list in proper sequence. Obeys the general contract of the Collection.toArray method.

Returns:
an array containing all of the elements in this list in proper sequence

toArray

IResourceTransition[] toArray(IResourceTransition[] a)
Returns an array containing all of the elements in this list in proper sequence; the runtime type of the returned array is that of the specified array. Obeys the general contract of the Collection.toArray(Object[]) method.

Parameters:
a - the array into which the elements of this list are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.
Returns:
an array containing the elements of this list
Throws:
ArrayStoreException - if the runtime type of the specified array is not a super type of the runtime type of every element in this list

add

boolean add(IResourceTransition o)
Appends the specified element to the end of this list (optional operation)

Depending on the runtime type of the contained list, this operation may place limitations on what elements can be added to this list. In particular, some lists refuse to add null elements, and others will impose restrictions on the type of elements that can be added. List classes should clearly specify in their documentation any restrictions on what elements can be added.

Parameters:
o - element to be appended to this list
Returns:
true (as per the general contract of the Collection.add method)
Throws:
UnsupportedOperationException - if the add method is not supported by this list
ClassCastException - if the class of the specified element prevents it from being added to this list
IllegalArgumentException - if some aspect of this element prevents it from being added to this collection

addAll

boolean addAll(IResourceTransitionList c)
               throws com.sapportals.wcm.WcmException
Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation). The behavior of this operation is unspecified if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it is not empty).

Parameters:
c - collection whose elements are to be added to this list
Returns:
true if this list changed as a result of the call
Throws:
UnsupportedOperationException - if the addAll method is not supported by this list
ClassCastException - if the class of an element in the specified collection prevents it from being added to this list
IllegalArgumentException - if some aspect of an element in the specified collection prevents it from being added to this list
com.sapportals.wcm.WcmException

get

IResourceTransition get(int index)
Returns the element at the specified position in this list

Parameters:
index - index of element to return
Returns:
the element at the specified position in this list
Throws:
IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

set

IResourceTransition set(int index,
                        IResourceTransition element)
Replaces the element at the specified position in this list with the specified element (optional operation)

Parameters:
index - index of element to replace
element - element to be stored at the specified position
Returns:
the element previously at the specified position
Throws:
UnsupportedOperationException - if the set method is not supported by this list
ClassCastException - if the class of the specified element prevents it from being added to this list
IllegalArgumentException - if some aspect of the specified element prevents it from being added to this list
IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).

add

void add(int index,
         IResourceTransition element)
Inserts the specified element at the specified position in this list (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Parameters:
index - index at which the specified element is to be inserted
element - element to be inserted
Throws:
UnsupportedOperationException - if the add method is not supported by this list
ClassCastException - if the class of the specified element prevents it from being added to this list
IllegalArgumentException - if some aspect of the specified element prevents it from being added to this list
IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size())

remove

IResourceTransition remove(int index)
Inserts the specified element at the specified position in this list (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Parameters:
index - index at which the specified element is to be inserted
element - element to be inserted
Throws:
UnsupportedOperationException - if the add method is not supported by this list
ClassCastException - if the class of the specified element prevents it from being added to this list
IllegalArgumentException - if some aspect of the specified element prevents it from being added to this list
IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size())

listIterator

IResourceTransitionIterator listIterator()
                                         throws com.sapportals.wcm.WcmException
Returns a list iterator of the elements in this list (in proper sequence)

Returns:
a list iterator of the elements in this list (in proper sequence)
Throws:
com.sapportals.wcm.WcmException

listIterator

IResourceTransitionIterator listIterator(int index)
                                         throws com.sapportals.wcm.WcmException
Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list. The specified index indicates the first element that would be returned by an initial call to the next method. An initial call to the previous method would return the element with the specified index minus one.

Parameters:
index - index of first element to be returned from the list iterator (by a call to the next method)
Returns:
a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list
Throws:
IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size())
com.sapportals.wcm.WcmException

subList

IResourceTransitionList subList(int fromIndex,
                                int toIndex)
                                throws com.sapportals.wcm.WcmException
Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list. The specified index indicates the first element that would be returned by an initial call to the next method. An initial call to the previous method would return the element with the specified index minus one.

Parameters:
index - index of first element to be returned from the list iterator (by a call to the next method)
Returns:
a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list
Throws:
IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size())
com.sapportals.wcm.WcmException
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] KMC-WPC [sap.com] tc/kmc/wpc/wpcfacade api EP-PIN-WPC-WCM
[sap.com] KMC-CM [sap.com] tc/km/frwk api EP-KM-CM


Copyright 2011 SAP AG Complete Copyright Notice