org.granite.tide.seam.Seam

	Property	Defined by
		busy : Boolean = false	Tide
		currentModulePrefix : String	Tide
		destination : String RemoteObject destination used	Tide
		disconnected : Boolean = false	Tide
		showBusyCursor : Boolean = true [static]	Tide

	Property	Defined by
		_ro : RemoteObject = null	Tide
		ro : RemoteObject	Tide
		_roInitialize : RemoteObject = null	Tide
		roInitialize : RemoteObject	Tide
		_rosByDestination : Dictionary	Tide

Public Methods

	Method		Defined by
		Seam(destination:String)	Seam
		addComponent(name:String, type:Class, inConversation:Boolean = false, autoCreate:Boolean = true, restrict:int, overrideIfPresent:Boolean = true):void Register a Tide component with a specified definition and scan dynamic dependency injections	Tide
		addComponentFromInstance(instance:Object, name:String, inConversation:Boolean = false):void Register a Tide component from an existing instance	Tide
		addComponents(types:Array):void Register many Tide components at once The component definitions are scanned from annotations	Tide
		addComponentWithFactory(name:String, type:Class, properties:Object, inConversation:Boolean = false, autoCreate:Boolean = true, restrict:int, overrideIfPresent:Boolean = true):void Register a Tide component with static dependency injections Dynamic dependency injections are also scanned	Tide
		addContextEventListener(type:String, handler:Function = null, remote:Boolean = false):void Add a context listener for a particular event type	Tide
		addEventObserver(eventType:String, componentName:String, methodName:String, remote:Boolean = false, create:Boolean = true, localOnly:Boolean = true):void Register an event observer	Tide
		addExceptionHandler(handlerClass:Class):void Add an exception handler class The class should implement IExceptionHandler	Tide
		addModule(module:Object, appDomain:ApplicationDomain = null):void Register a Tide module	Tide
		addPlugin(plugin:ITidePlugin):void Register a plugin instance	Tide
		checkLoggedIn(ctx:BaseContext, component:IComponent, responder:ITideResponder = null):AsyncToken	Seam
		checkWaitForLogout():void Notify the framework that it should wait for a async operation before effectively logging out.	Tide
		createOperation(name:String, ro:RemoteObject = null):TideOperation	Seam
		currentApplication():Object [static] Internal method to determine current application in both Flex 3 and Flex 4	Tide
		getComponentRemoteSync(name:String):int Return the remote synchronization type of the component	Tide
		getComponentRestrict(name:String):int Return the security restriction of the component	Tide
		getComponentScope(name:String):int Returns the scope of a component	Tide
		getContext(contextId:String = null, parentContextId:String = null, create:Boolean = true):BaseContext Return a context from its id	Tide
		getInstance(destination:String = null):Seam [static]	Seam
		getManagedInstance(component:Object):Array	Tide
		getRemoteObject(componentName:String):RemoteObject Returns the internal RemoteObject used for a particular component name	Tide
		getSeamContext(conversationId:String = null):Context	Seam
		initApplication(autoRegisterUIComponents:Boolean = true):void Init the Tide application	Tide
		internalNameForTypedComponent(name:String):String [static]	Tide
		isComponent(name:String):Boolean Checks a name is a registered Tide component	Tide
		isComponentAutoCreate(name:String):Boolean Returns the creation policy of a component	Tide
		isComponentDefaultProxy(name:String):Boolean Return the proxy status of the component	Tide
		isComponentGlobal(name:String):Boolean Return if the specific component is defined as global (not in a namespace)	Tide
		isComponentInConversation(name:String):Boolean Returns the scope of a component	Tide
		isComponentInEvent(name:String):Boolean Returns the scope of a component	Tide
		isComponentInSession(name:String):Boolean Returns the scope of a component	Tide
		isComponentRestrict(name:String):Boolean Return the security restriction of the component	Tide
		isSubcontext(name:String):Boolean Checks a name is a registered Tide subcontext	Tide
		login(ctx:BaseContext, component:IComponent, username:String, password:String, responder:ITideResponder = null, charset:String = null):AsyncToken	Seam
		processInterceptors(message:IMessage, before:Boolean):void	Tide
		removeComponent(name:String):void Unregister a Tide component and destroys all instances	Tide
		removeContextEventListener(type:String, handler:Function):void Unregister a context event listener	Tide
		removeManagedInstance(component:Object):void	Tide
		removeModule(module:Object):void Unregister a Tide module	Tide
		removeProxyDescriptor(name:, value:):void Remove descriptor for proxy when value is no more a proxy	Tide
		resetInstance():void [static] Clear Tide singleton (should be used only for testing)	Seam
		setComponentAutoCreate(name:String, autoCreate:Boolean):void Define the creation policy of the component	Tide
		setComponentCustomDescriptor(name:String, xmlDescriptor:XML):void Define the custom XML descriptor for the component	Tide
		setComponentGlobal(name:String, global:Boolean):void Define if the component is defined as global (cannot be in a namespace/subcontext)	Tide
		setComponentRemoteSync(name:String, remoteSync:int):void Define the remote synchronization of the component If false, the component state will never be sent to the server	Tide
		setComponentRestrict(name:String, restrict:int):void Define the security restriction of the component If RESTRICT_YES, the component state will be cleared when user logs out Default value is RESTRICT_UNKNOWN meaning if will be inferred from server definition when possible	Tide
		setComponentScope(name:String, scope:int):void Define the scope of a component	Tide
		setManagedInstance(component:Object, context:BaseContext, name:String):void	Tide
		tryLogout():void Try logout.	Tide

	Method	Defined by
		extractContextId(event:MessageEvent, fromFault:Boolean = false):String	Seam
		init(contextClass:Class, componentClass:Class):void	Seam
		initRemoteObject():void	Seam
		isLoggedIn():Boolean	Seam
		resetApplication():void Resets Tide application (mainly used in test cases)	Tide
		setLoggedIn(value:Boolean):void	Seam
		wasConversationCreated(event:MessageEvent):Boolean	Seam
		wasConversationEnded(event:MessageEvent):Boolean	Seam

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined by
		CONTEXT_CREATE : String = "org.granite.tide.contextCreate" [static]	Tide
		CONTEXT_DESTROY : String = "org.granite.tide.contextDestroy" [static]	Tide
		CONTEXT_FAULT : String = "org.granite.tide.contextFault" [static]	Tide
		CONTEXT_RESULT : String = "org.granite.tide.contextResult" [static]	Tide
		CONVERSATION_PROPAGATION_TAG : String = "conversationPropagation" [static]	Tide
		CONVERSATION_TAG : String = "conversationId" [static]	Tide
		DEFAULT_CONTEXT : String = "__DEFAULT_CONTEXT__" [static]	Tide
		IS_FIRST_CALL_TAG : String = "org.granite.tide.isFirstCall" [static]	Tide
		IS_FIRST_CONVERSATION_CALL_TAG : String = "org.granite.tide.isFirstConversationCall" [static]	Tide
		IS_LONG_RUNNING_CONVERSATION_TAG : String = "isLongRunningConversation" [static]	Tide
		LOGGED_OUT : String = "org.granite.tide.loggedOut" [static]	Tide
		LOGIN : String = "org.granite.tide.login" [static]	Tide
		LOGOUT : String = "org.granite.tide.logout" [static]	Tide
		PLUGIN_ADD_COMPONENT : String = "org.granite.tide.plugin.addComponent" [static]	Tide
		PLUGIN_LOGIN_FAULT : String = "org.granite.tide.plugin.loginFault" [static]	Tide
		PLUGIN_LOGIN_SUCCESS : String = "org.granite.tide.plugin.loginSuccess" [static]	Tide
		PLUGIN_LOGOUT : String = "org.granite.tide.plugin.logout" [static]	Tide
		PLUGIN_SET_CREDENTIALS : String = "org.granite.tide.plugin.setCredentials" [static]	Tide
		QCN_BASECONTEXT : String = "" [static]	Tide
		QCN_ICOMPONENT : String = "" [static]	Tide
		QCN_IENTITY : String = "" [static]	Tide
		QCN_ILIST : String = "" [static]	Tide
		QCN_IUICOMPONENT : String = "" [static]	Tide
		QCN_SUBCONTEXT : String = "" [static]	Tide
		RESTRICT_NO : int = 1 [static]	Tide
		RESTRICT_UNKNOWN : int = 0 [static]	Tide
		RESTRICT_YES : int = 2 [static]	Tide
		SCOPE_CONVERSATION : int = 2 [static]	Tide
		SCOPE_EVENT : int = 3 [static]	Tide
		SCOPE_SESSION : int = 1 [static]	Tide
		SCOPE_UNKNOWN : int = 0 [static]	Tide
		SESSION_EXPIRED : String = "org.granite.tide.sessionExpired" [static]	Tide
		STARTUP : String = "org.granite.tide.startup" [static]	Tide
		SYNC_BIDIRECTIONAL : int = 2 [static]	Tide
		SYNC_NONE : int = 0 [static]	Tide
		SYNC_SERVER_TO_CLIENT : int = 1 [static]	Tide
		TYPED_IMPL_PREFIX : String = "__typedImpl__" [static]	Tide
		TYPE_SUBCONTEXT : Type [static]	Tide
		WAS_LONG_RUNNING_CONVERSATION_CREATED_TAG : String = "wasLongRunningConversationCreated" [static]	Tide
		WAS_LONG_RUNNING_CONVERSATION_ENDED_TAG : String = "wasLongRunningConversationEnded" [static]	Tide
		WINDOW_CLOSE : String = "globalNotifyWindowClose" [static]	Tide
		WINDOW_CREATE : String = "globalNotifyWindowCreate" [static]	Tide

Constructor detail

Seam

()

constructor

public function Seam(destination:String)Parameters

destination:String

Method detail

checkLoggedIn

()

method

public override function checkLoggedIn(ctx:BaseContext, component:IComponent, responder:ITideResponder = null):AsyncToken

Parameters

	`ctx:BaseContext`

	`component:IComponent`

	`responder:ITideResponder` (default = `null`)

Returns

AsyncToken

createOperation

()

method

public override function createOperation(name:String, ro:RemoteObject = null):TideOperationParameters

	`name:String`

	`ro:RemoteObject` (default = `null`)

Returns

TideOperation

extractContextId

()

method

protected override function extractContextId(event:MessageEvent, fromFault:Boolean = false):StringParameters

	`event:MessageEvent`

	`fromFault:Boolean` (default = `false`)

Returns

String

getInstance

()

method

public static function getInstance(destination:String = null):SeamParameters

destination:String (default = null)

Returns

Seam

getSeamContext

()

method

public function getSeamContext(conversationId:String = null):ContextParameters

conversationId:String (default = null)

Returns

Context

init

()

method

protected override function init(contextClass:Class, componentClass:Class):voidParameters

	`contextClass:Class`

	`componentClass:Class`

initRemoteObject

()

method

protected override function initRemoteObject():void

isLoggedIn

()

method

protected override function isLoggedIn():Boolean

Returns

Boolean

()

method

public override function login(ctx:BaseContext, component:IComponent, username:String, password:String, responder:ITideResponder = null, charset:String = null):AsyncToken

Parameters

	`ctx:BaseContext`

	`component:IComponent`

	`username:String`

	`password:String`

	`responder:ITideResponder` (default = `null`)

	`charset:String` (default = `null`)

Returns

AsyncToken

resetInstance

()

method

public static function resetInstance():void

Clear Tide singleton (should be used only for testing)

setLoggedIn

()

method

protected override function setLoggedIn(value:Boolean):voidParameters

value:Boolean

wasConversationCreated

()

method

protected override function wasConversationCreated(event:MessageEvent):BooleanParameters

event:MessageEvent

Returns

Boolean

wasConversationEnded

()

method

protected override function wasConversationEnded(event:MessageEvent):BooleanParameters

event:MessageEvent

Returns

Boolean

Granite Data Services API Documentation (3.0.0.M2)	All Packages \| All Classes \| Index \| Frames No Frames
Class Seam	Properties \| Methods \| Constants

Package	org.granite.tide.seam
Class	public class Seam
Inheritance	Seam Tide flash.events.EventDispatcher