wt.admin
Interface AdministrativeDomainManagerSvr

All Known Implementing Classes:

StandardAdministrativeDomainManager

public interface AdministrativeDomainManagerSvr

Supported API: true

Extendable: false

Method Summary

wt.admin.DomainAdministered	replaceAdministrativeDomain(wt.admin.DomainAdministered from, wt.admin.DomainAdministered to, boolean commit_change) Copies the domain reference in the 'from' object to the 'to' object and sets the inheritedDomain attribute to true.
WTList	replaceAdministrativeDomain(wt.admin.DomainAdministered from, WTList to_objs, boolean commit_change) Multi-object version of the replaceAdministrativeDomain() API.
WTList	replaceAdministrativeDomain(WTList from_objs, WTList to_objs, boolean commit_change) Multi-object version of the replaceAdministrativeDomain() API.

Method Detail

replaceAdministrativeDomain

wt.admin.DomainAdministered replaceAdministrativeDomain(wt.admin.DomainAdministered from,
                                                        wt.admin.DomainAdministered to,
                                                        boolean commit_change)
                                                        throws WTException

Copies the domain reference in the 'from' object to the 'to' object and sets the inheritedDomain attribute to true. Posts PRE_CHANGE_DOMAIN and POST_CHANGE_DOMAIN events. Persists the changes and returns the changed object if commit_change is true.

Supported API: true

Parameters:

from - The domain administered object to copy the domain reference from. If from is null, a WTInvalidParameterException is thrown.

to - The domain administered object to copy the domain reference to. If to is null, a WTInvalidParameterException is thrown.

commit_change -

Returns:

DomainAdministered

Throws:

WTException

replaceAdministrativeDomain

WTList replaceAdministrativeDomain(wt.admin.DomainAdministered from,
                                   WTList to_objs,
                                   boolean commit_change)
                                   throws WTException

Multi-object version of the replaceAdministrativeDomain() API. The domain reference in the from DomainAdministered object is copied to each DomainAdministered object in the to_objs collection and each object's inheritedDomain attribute is set to true.

The to_objs collection must contain one or more DomainAdministered objects.The exception is if you want to replace the domain that an AdministrativeDomain object belongs to. In this case the to_objs collection can contain only one DomainAdministered object which is the AdministrativeDomain object being modified. If to_objs contains multiple objects and one or more of them is an AdministrativeDomain, a AdministrativeDomainException is thrown.

Multi-object PRE_CHANGE_DOMAIN and POST_CHANGE_DOMAIN events are posted before and after modifying the DomainAdministered objects in the to_objs collection.

If commit_change is true, the domain changes for each DomainAdministered object in the to_objs collection are persisted.

A collection of the modified DomainAdministered objects is returned.

Supported API: true

Parameters:

from - The DomainAdministered object to copy the domain reference from. If from is null, a WTInvalidParameterException is thrown.

to_objs - Collection of DomainAdministered objects to copy the from object's domain reference to. If to_objs is null or empty, a WTInvalidParameterException is thrown.

commit_change - If true, the objects in the to_objs collection are persisted after changing their domains.

Returns:

WTList

Throws:

WTException

replaceAdministrativeDomain

WTList replaceAdministrativeDomain(WTList from_objs,
                                   WTList to_objs,
                                   boolean commit_change)
                                   throws WTException

Multi-object version of the replaceAdministrativeDomain() API. For each DomainAdministered object in the from_objs collection, the domain reference is copied from the from_obj object to the corresponding DomainAdministered object in the to_objs collection and the inheritedDomain attribute is set to true for each to_objs object.

The to_objs collection must contain one or more DomainAdministered objects.The exception is if you want to replace the domain that an AdministrativeDomain object belongs to. In this case the to_objs collection can contain only one DomainAdministered object which is the AdministrativeDomain object being modified. If to_objs contains multiple objects and one or more of them is an AdministrativeDomain, a AdministrativeDomainException is thrown. If to_objs is null or empty, a WTInvalidParameterException is thrown.

The from_objs collection must contain either 1) a single DomainAdministered object or 2) the same number of DomainAdministered objects as are DomainAdministered objects in the to_objs collection. If from_objs contains one DomainAdministered object, the domain reference from this DomainAdministered object is copied to each DomainAdministered object in the to_objs collection; otherwise, the first from_objs DomainAdministered object's domain reference is copied to the first to_objs DomainAdministered object, the second from_objs DomainAdministered object's domain reference is copied to the second to_objs DomainAdministered object, and so on. If from_objs is null, empty, or the wrong size, a WTInvalidParameterException is thrown.

Multi-object PRE_CHANGE_DOMAIN and POST_CHANGE_DOMAIN events are posted before and after modifying the DomainAdministered objects in the to_objs collection.

If commit_change is true, the domain changes for each DomainAdministered object in the to_objs collection are persisted.

A collection of the modified DomainAdministered objects is returned.

Supported API: true

Parameters:

from_objs - Collection of DomainAdministered objects to copy the domain references from.

to_objs - Collection of DomainAdministered objects to copy the from_objs domain references to.

commit_change - If true, the objects in the to_objs collection are persisted after changing their domains.

Returns:

WTList

Throws:

WTException