org.opencrx.kernel.home1.jmi1
Interface Subscription

All Superinterfaces:
org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.ExtentCapable, RefBaseObject, RefFeatured, RefObject, SecureObject, Subscription, org.openmdx.compatibility.view1.cci2.ViewCapable

public interface Subscription
extends Subscription, SecureObject, Subscription, org.openmdx.base.jmi1.BasicObject

Class Subscription


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.opencrx.kernel.home1.cci2.Subscription
Subscription.Identity
 
Method Summary
 void addOwningGroup(int index, PrincipalGroup newValue)
          
 void addOwningGroup(PrincipalGroup newValue)
          
 org.openmdx.base.cci2.BasicObject getAccessGrantedByParent()
          Retrieves the value for the reference accessGrantedByParent.
 Set<Short> getEventType()
           
 Set<String> getFilterValue0()
           
 Set<String> getFilterValue1()
           
 Set<String> getFilterValue2()
           
 Set<String> getFilterValue3()
           
 Set<String> getFilterValue4()
           
 User getOwningUser()
          Retrieves the value for the reference owningUser.
 Topic getTopic()
          Retrieves the value for the reference topic.
<T extends org.openmdx.compatibility.view1.cci2.View>
List<T>
getView(org.openmdx.compatibility.view1.cci2.ViewQuery query)
          Retrieves the value for the reference view for the specified query.
 void removeOwningGroup(int index)
          
 void removeOwningUser()
          Removes the value for the optional reference owningUser.
 void removeTopic()
          Removes the value for the optional reference topic.
 void setEventType(Set<Short> eventType)
           This method is equivalent to
 void setFilterValue0(Set<String> filterValue0)
           This method is equivalent to
 void setFilterValue1(Set<String> filterValue1)
           This method is equivalent to
 void setFilterValue2(Set<String> filterValue2)
           This method is equivalent to
 void setFilterValue3(Set<String> filterValue3)
           This method is equivalent to
 void setFilterValue4(Set<String> filterValue4)
           This method is equivalent to
 void setOwningUser(User owningUser)
          Sets a new value for the reference owningUser.
 void setTopic(Topic topic)
          Sets a new value for the reference topic.
 void setUserHome(UserHome userHome)
          Sets a new value for the reference userHome.
 void setUserHome(UserHome userHome, boolean idIsPersistent, String id)
          Set the object's composite association org:opencrx:kernel:home1:UserHomeContainsSubscription.
 
Methods inherited from interface org.opencrx.kernel.home1.cci2.Subscription
getDescription, getFilterName0, getFilterName1, getFilterName2, getFilterName3, getFilterName4, getName, isActive, setActive, setDescription, setEventType, setFilterName0, setFilterName1, setFilterName2, setFilterName3, setFilterName4, setFilterValue0, setFilterValue1, setFilterValue2, setFilterValue3, setFilterValue4, setName
 
Methods inherited from interface org.opencrx.kernel.base.jmi1.SecureObject
addOwningGroup, getOwner, removeAllOwningGroup, removeOwningGroup, setAccessLevel, setOwningUser
 
Methods inherited from interface org.opencrx.kernel.base.cci2.SecureObject
addOwningGroup, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwningGroup, removeAllOwningGroup, removeOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwningUser
 
Methods inherited from interface org.openmdx.base.jmi1.BasicObject
getCreatedBy, getModifiedBy
 
Methods inherited from interface org.openmdx.base.cci2.BasicObject
getCreatedAt, getModifiedAt
 
Methods inherited from interface org.openmdx.base.cci2.ExtentCapable
getIdentity
 
Methods inherited from interface org.openmdx.compatibility.view1.cci2.ViewCapable
getView
 
Methods inherited from interface javax.jmi.reflect.RefObject
refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite
 
Methods inherited from interface javax.jmi.reflect.RefFeatured
refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue
 
Methods inherited from interface javax.jmi.reflect.RefBaseObject
equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints
 

Method Detail

getAccessGrantedByParent

org.openmdx.base.cci2.BasicObject getAccessGrantedByParent()
Retrieves the value for the reference accessGrantedByParent.

Specified by:
getAccessGrantedByParent in interface SecureObject
Returns:
The – possibly null – value for this reference.

addOwningGroup

void addOwningGroup(int index,
                    PrincipalGroup newValue)

Parameters:
index - The qualifier attribute value that qualifies the reference to get the element to be appended.
newValue - The element to be appended.

addOwningGroup

void addOwningGroup(PrincipalGroup newValue)

Parameters:
newValue - The element to be appended.

removeOwningGroup

void removeOwningGroup(int index)


getOwningUser

User getOwningUser()
Retrieves the value for the reference owningUser.

Specified by:
getOwningUser in interface SecureObject
Returns:
The – possibly null – value for this reference.

setOwningUser

void setOwningUser(User owningUser)
Sets a new value for the reference owningUser.

Specified by:
setOwningUser in interface SecureObject
Parameters:
owningUser - The non-null new value for this reference.

removeOwningUser

void removeOwningUser()
Removes the value for the optional reference owningUser.


getEventType

Set<Short> getEventType()
Returns:
A set containing all elements for this attribute.

setEventType

void setEventType(Set<Short> eventType)

This method is equivalent to

   set.clear();
   set.addAll(eventType);
 

Parameters:
eventType - collection to be copied.

getFilterValue0

Set<String> getFilterValue0()
Returns:
A set containing all elements for this attribute.

setFilterValue0

void setFilterValue0(Set<String> filterValue0)

This method is equivalent to

   set.clear();
   set.addAll(filterValue0);
 

Parameters:
filterValue0 - collection to be copied.

getFilterValue1

Set<String> getFilterValue1()
Returns:
A set containing all elements for this attribute.

setFilterValue1

void setFilterValue1(Set<String> filterValue1)

This method is equivalent to

   set.clear();
   set.addAll(filterValue1);
 

Parameters:
filterValue1 - collection to be copied.

getFilterValue2

Set<String> getFilterValue2()
Returns:
A set containing all elements for this attribute.

setFilterValue2

void setFilterValue2(Set<String> filterValue2)

This method is equivalent to

   set.clear();
   set.addAll(filterValue2);
 

Parameters:
filterValue2 - collection to be copied.

getFilterValue3

Set<String> getFilterValue3()
Returns:
A set containing all elements for this attribute.

setFilterValue3

void setFilterValue3(Set<String> filterValue3)

This method is equivalent to

   set.clear();
   set.addAll(filterValue3);
 

Parameters:
filterValue3 - collection to be copied.

getFilterValue4

Set<String> getFilterValue4()
Returns:
A set containing all elements for this attribute.

setFilterValue4

void setFilterValue4(Set<String> filterValue4)

This method is equivalent to

   set.clear();
   set.addAll(filterValue4);
 

Parameters:
filterValue4 - collection to be copied.

getTopic

Topic getTopic()
Retrieves the value for the reference topic.

Returns:
The – possibly null – value for this reference.

setTopic

void setTopic(Topic topic)
Sets a new value for the reference topic.

Parameters:
topic - The non-null new value for this reference.

removeTopic

void removeTopic()
Removes the value for the optional reference topic.


getView

<T extends org.openmdx.compatibility.view1.cci2.View> List<T> getView(org.openmdx.compatibility.view1.cci2.ViewQuery query)
Retrieves the value for the reference view for the specified query.

Parameters:
query - predicate which is applied to the set of referenced objects.
Returns:
The objects for which the predicate evaluates to true.

setUserHome

void setUserHome(UserHome userHome)
Sets a new value for the reference userHome.

Parameters:
userHome - The non-null new value for this reference.

setUserHome

void setUserHome(UserHome userHome,
                 boolean idIsPersistent,
                 String id)
Set the object's composite association org:opencrx:kernel:home1:UserHomeContainsSubscription.

Parameters:
userHome - The non-null new value for this object's composite owner.
idIsPersistent - Defines whether the id is persistent.
id - The non-null new value for this object's qualifier.


This software is published under the BSD license. Copyright © 2003-2007, CRIXP AG, Switzerland, All rights reserved. Use is subject to license terms.