| パッケージ | lc.foundation.domain |
| クラス | public class Principal |
| 継承 | Principal  DomainObject Object |
| 実装 | IManaged |
| サブクラス | Group, User |
| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| ランタイムバージョン: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Principal class is base class for both the User and Group classes and contains a set of common attributes.
継承されるパブリックプロパティを隠す
継承されるパブリックプロパティを表示| プロパティ | 定義元 | ||
|---|---|---|---|
| canonicalName : String
The user's canonical name. | Principal | ||
| commonName : String
The user's common (display) name. | Principal | ||
 | constructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。 | Object | |
| description : String
A description of the user. | Principal | ||
| directGroupMemberships : ArrayCollection
The groups to which a user directly belongs. | Principal | ||
| domainCommonName : String
The user's common domain main. | Principal | ||
| domainName : String
The user directory's domain name for which the user is defined. | Principal | ||
| email : String
The email address of the user. | Principal | ||
| emailAliases : Array
The email aliases for the user. | Principal | ||
| groupMemberships : ArrayCollection
All groups to which a user belongs. | Principal | ||
| local : Boolean
The user's local value. | Principal | ||
| locked : Boolean
Specifies whether the user is locked. | Principal | ||
| oid : String
The unique identifier for the user called a object identifier. | Principal | ||
| org : String
The user's organization name. | Principal | ||
| principalType : String
The user's common domain main. | Principal | ||
| roleMembership : ArrayCollection
The roles to which a user belongs. | Principal | ||
| session : SessionMap [読み取り専用]
A SessionMap object that stores information relating to the server session. | DomainObject | |
| status : String
The user's common domain main. | Principal | ||
| system : Boolean
A flag value that specifies whether the principal is a system principal. | Principal | ||
| visibility : Number
The user's visibility value. | Principal | ||
| メソッド | 定義元 | ||
|---|---|---|---|
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | Principal | ||
Dispatches an event into the event flow. | Principal | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | Principal | ||
|
オブジェクトに指定されたプロパティが定義されているかどうかを示します。 | Object | |
|
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。 | Object | |
|
指定されたプロパティが存在し、列挙できるかどうかを示します。 | Object | |
Removes a listener from the EventDispatcher object. | Principal | ||
|
ループ処理に対するダイナミックプロパティの可用性を設定します。 | Object | |
|
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのストリング表現を返します。 | Object | |
|
指定されたオブジェクトのプリミティブな値を返します。 | Object | |
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | Principal | ||
canonicalName | プロパティ |
canonicalName:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| ランタイムバージョン: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The user's canonical name. This string is unique within the scope of the domain.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange イベントが送出されます。
実装
public function get canonicalName():String public function set canonicalName(value:String):voidcommonName | プロパティ |
commonName:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| ランタイムバージョン: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The user's common (display) name.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange イベントが送出されます。
実装
public function get commonName():String public function set commonName(value:String):voiddescription | プロパティ |
description:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| ランタイムバージョン: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A description of the user.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange イベントが送出されます。
実装
public function get description():String public function set description(value:String):voiddirectGroupMemberships | プロパティ |
directGroupMemberships:ArrayCollection| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| ランタイムバージョン: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The groups to which a user directly belongs.
The returned ArrayCollection object contains Group objects.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange イベントが送出されます。
実装
public function get directGroupMemberships():ArrayCollection public function set directGroupMemberships(value:ArrayCollection):void関連する API エレメント
domainCommonName | プロパティ |
domainCommonName:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| ランタイムバージョン: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The user's common domain main.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange イベントが送出されます。
実装
public function get domainCommonName():String public function set domainCommonName(value:String):voiddomainName | プロパティ |
domainName:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| ランタイムバージョン: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The user directory's domain name for which the user is defined.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange イベントが送出されます。
実装
public function get domainName():String public function set domainName(value:String):void| プロパティ |
email:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| ランタイムバージョン: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The email address of the user.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange イベントが送出されます。
実装
public function get email():String public function set email(value:String):voidemailAliases | プロパティ |
emailAliases:Array| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| ランタイムバージョン: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The email aliases for the user. The email aliases are in addition to the
main email address specified by the email property.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange イベントが送出されます。
実装
public function get emailAliases():Array public function set emailAliases(value:Array):voidgroupMemberships | プロパティ |
groupMemberships:ArrayCollection| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| ランタイムバージョン: | AIR (unsupported), Flash Player 9, Flash Player 10 |
All groups to which a user belongs.
The returned ArrayCollection object contains Group objects.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange イベントが送出されます。
実装
public function get groupMemberships():ArrayCollection public function set groupMemberships(value:ArrayCollection):void関連する API エレメント
local | プロパティ |
local:Boolean| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| ランタイムバージョン: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The user's local value.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange イベントが送出されます。
実装
public function get local():Boolean public function set local(value:Boolean):voidlocked | プロパティ |
locked:Boolean| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| ランタイムバージョン: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Specifies whether the user is locked. A locked principal cannot log onto the Document Server and requires
an administrator to unlock it. A value of True specifies that the user is locked.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange イベントが送出されます。
実装
public function get locked():Boolean public function set locked(value:Boolean):voidoid | プロパティ |
oid:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| ランタイムバージョン: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The unique identifier for the user called a object identifier.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange イベントが送出されます。
実装
public function get oid():String public function set oid(value:String):voidorg | プロパティ |
org:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| ランタイムバージョン: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The user's organization name.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange イベントが送出されます。
実装
public function get org():String public function set org(value:String):voidprincipalType | プロパティ |
principalType:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| ランタイムバージョン: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The user's common domain main.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange イベントが送出されます。
実装
public function get principalType():String public function set principalType(value:String):voidroleMembership | プロパティ |
roleMembership:ArrayCollection| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| ランタイムバージョン: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The roles to which a user belongs. The roles returned are either directly assigned or inherited by the principal from its ancestors.
The returned ArrayCollection object contains String objects.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange イベントが送出されます。
実装
public function get roleMembership():ArrayCollection public function set roleMembership(value:ArrayCollection):void関連する API エレメント
status | プロパティ |
status:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| ランタイムバージョン: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The user's common domain main.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange イベントが送出されます。
実装
public function get status():String public function set status(value:String):voidsystem | プロパティ |
system:Boolean| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| ランタイムバージョン: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A flag value that specifies whether the principal is a system principal.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange イベントが送出されます。
実装
public function get system():Boolean public function set system(value:Boolean):voidvisibility | プロパティ |
visibility:Number| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| ランタイムバージョン: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The user's visibility value. The visibility level of the principal, indicates whether the principal can be shown in the user interface, or whether it qualifies for searches.
このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 propertyChange イベントが送出されます。
実装
public function get visibility():Number public function set visibility(value:Number):voidaddEventListener | () | メソッド |
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):voidRegisters an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.
After you successfully register an event listener, you cannot change its priority
through additional calls to addEventListener(). To change a listener's priority, you
must first call removeEventListener(). Then you can register the listener again with the new
priority level.
After the listener is registered, subsequent calls to
addEventListener() with a different value for either type or useCapture result in the
creation of a separate listener registration. For example, if you first register a
listener with useCapture set to true, it listens only during the capture phase. If you
call addEventListener() again using the same listener object, but with useCapture set to
false, you have two separate listeners: one that listens during the capture phase, and
another that listens during the target and bubbling phases.
You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.
When you no longer need an event listener, remove it by calling EventDispatcher.removeEventListener(); otherwise, memory problems might result. Objects
with registered event listeners are not automatically removed from memory because the
garbage collector does not remove objects that still have references.
Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.
If the event listener is being registered on a node while an event is also being processed on this node, the event listener is not triggered during the current phase but may be triggered during a later phase in the event flow, such as the bubbling phase.
If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless it is registered again for future processing).
パラメーター
type:String — The type of event.
| |
listener:Function — The listener function that processes the event. This function must accept an event object
as its only parameter and must return nothing, as this example shows:
| |
useCapture:Boolean (default = false)useCapture is set to true, the
listener processes the event only during the capture phase and not in the target or
bubbling phase. If useCapture is false, the listener processes the event only
during the target or bubbling phase. To listen for the event in all three phases, call
addEventListener() twice, once with useCapture set to true,
then again with useCapture set to false.
| |
priority:int (default = 0) | |
weakRef:Boolean (default = false)Class-level member functions are not subject to garbage
collection, so you can set |
dispatchEvent | () | メソッド |
public function dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow. The event target is the
EventDispatcher object upon which dispatchEvent() is called.
パラメーター
event:Event — The event object dispatched into the event flow.
|
Boolean — A value of true unless preventDefault() is called on the event,
in which case it returns false.
|
hasEventListener | () | メソッド |
public function hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether
a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger().
The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.
パラメーター
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type is registered; false otherwise.
|
removeEventListener | () | メソッド |
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):voidRemoves a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.
パラメーター
type:String — The type of event.
| |
listener:Function — The listener object to remove.
| |
useCapture:Boolean (default = false)removeEventListener() are required to remove both: one call with useCapture set to true, and another call with useCapture set to false.
|
willTrigger | () | メソッド |
public function willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.
The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.
パラメーター
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.
|
Tue Jun 12 2018, 10:34 AM Z