com.portal.app.comp

Interface PBrandBean

All Superinterfaces:

Remote

All Known Implementing Classes:

PBrandBeanImpl

public interface PBrandBean
extends Remote

An interface describing the abilities needed for brand component.

Version:

%version: 2.1.3 % %date_modified: Mon Apr 30 15:19:05 2001 %

Author:

raghuv

Method Summary

Modifier and Type	Method and Description
PScopeEntryPoint	getActiveBrand() Returns the active brand through the PScopeEntryPoint Object.
TreeModel	getBrands() Returns the Brand hierarchy in a swing TreeModel.
boolean	isBrandingEnabled() Check if branding is enabled.
boolean	isDummyRoot() Returns true if the root node of the tree model is a dummy root node only serving the purpose of parenting loose brands and account groups.
PScopeEntryPoint	lookupBrandFromPoid(PModelHandle brandPoid) Used to lookup the brand that is associated with the given brand poid.
void	retrieveBrands() Retrieves the Brand hierarchy from the database.
boolean	setActiveBrand(PScopeEntryPoint newActiveBrand) Sets the given brand as the new active brand in the infranet system.

Method Detail

getBrands

TreeModel getBrands()
             throws RemoteException

Returns the Brand hierarchy in a swing TreeModel. The root node may be dummy only serving the purpose of parenting the loose brands. Use isDummy() on the root node to determine if it is just a dummy root node.

Returns:

TreeModel

Throws:

RemoteException

RemoteException - <>

lookupBrandFromPoid

PScopeEntryPoint lookupBrandFromPoid(PModelHandle brandPoid)
                              throws RemoteException

Used to lookup the brand that is associated with the given brand poid. The brand poid should be available as a PScopeEntryPoint in the Context.

Parameters:

brandPoid - A PModelHandle object representing a Brand poid object.

Returns:

PScopeEntryPoint representing brand name.

Throws:

RemoteException

isDummyRoot

boolean isDummyRoot()
             throws RemoteException

Returns true if the root node of the tree model is a dummy root node only serving the purpose of parenting loose brands and account groups. (In such a case root node is invisible in the tree displayed)

Throws:

RemoteException

getActiveBrand

PScopeEntryPoint getActiveBrand()
                         throws RemoteException

Returns the active brand through the PScopeEntryPoint Object. Use different methods available on PScopeEntryPoint to obtain brand name, ACL poid, etc.

Returns:

ScopeEntryPoint

Throws:

RemoteException

RemoteException - <>

setActiveBrand

boolean setActiveBrand(PScopeEntryPoint newActiveBrand)
                throws RemoteException

Sets the given brand as the new active brand in the infranet system.

Parameters:

PScopeEntryPoint - A Brand info object containing the brand to which the credentials/scope should be set to

Returns:

Returns true if active brand was set successfully, else returns false.

Throws:

RemoteException

RemoteException - <>

isBrandingEnabled

boolean isBrandingEnabled()
                   throws RemoteException

Check if branding is enabled.

Returns:

true if Branding is enabled, false otherwise.

Throws:

RemoteException

RemoteException - <>

retrieveBrands

void retrieveBrands()
             throws RemoteException

Retrieves the Brand hierarchy from the database. This causes an opcode call be made to infranet to retrieve the brand hierarchy and update the component data. Unlike getBrands(), this forces a call to back end to get the updated brand hierarchy instead of returning one from the cache.

Throws:

RemoteException

RemoteException - <>