Log in


Forgot your password?
New user?
 
You are here: Home / API Documentation / Products.RPMManager.RPMAgent

 Products.RPMManager.RPMAgent  

Up one level
Zpydoc Products → RPMManager → RPMAgent
Classes
Class  class RPMAgent ( PortalContent )
A commission-based RPMUser
Plus Lock  RPMManager: Add Agents
Implements IRPMAgent IAgentSchema ILocalPortletAssignable IUUIDAware IAttributeUUID IDynamicType IDublinCore ICatalogableDublinCore IMutableDublinCore IPropertyManager IJSONRepresentation ISimpleItem IItem IDAVResource IWriteLock EtagBaseInterface ICopySource ITraversable IOwned IUndoSupport IPersistentExtra IPersistent IAcquirer IRoleManager IPermissionMappingSupport ICatalogAware IWorkflowAware IOpaqueItemManager
Method COPY(self, REQUEST, RESPONSE)
Create a duplicate of the source resource whose state and behavior match that of the source resource as closely as possible. Though we may later try to make a copy appear seamless across namespaces (e.g. from Zope to Apache), COPY is currently only supported within the Zope namespace.
Method Contributors(self)
Lock   View
Deprecated alias of listContributors.
Method CreationDate(self, zone=None)
Lock   View
Dublin Core Date element - date resource created.
Method Creator(self)
Lock   View
Dublin Core Creator element - resource author.
Method DELETE(self, REQUEST, RESPONSE)
Delete a resource. For non-collection resources, DELETE may return either 200 or 204 (No Content) to indicate success.
Method Date(self, zone=None)
Lock   View
Dublin Core Date element - default date.
Method Description(self)
Lock   View
Dublin Core Description element - resource summary.
Method EffectiveDate(self, zone=None)
Lock   View
Method ExpirationDate(self, zone=None)
Lock   View
Method Format(self)
Lock   View
Dublin Core Format element - resource format.
Method HEAD(self, REQUEST, RESPONSE)
Retrieve resource information without a response body.
Method Identifier(self)
Lock   View
Dublin Core Identifier element - resource ID.
Method LOCK(self, REQUEST, RESPONSE)
Lock a resource
Method Language(self)
Lock   View
Dublin Core Language element - resource language.
Method MKCOL(self, REQUEST, RESPONSE)
Create a new collection resource. If called on an existing resource, MKCOL must fail with 405 (Method Not Allowed).
Method MOVE(self, REQUEST, RESPONSE)
Move a resource to a new location. Though we may later try to make a move appear seamless across namespaces (e.g. from Zope to Apache), MOVE is currently only supported within the Zope namespace.
Method ModificationDate(self, zone=None)
Lock   View
Dublin Core Date element - date resource last modified.
Method OPTIONS(self, REQUEST, RESPONSE)
Retrieve communication options.
Method PROPFIND(self, REQUEST, RESPONSE)
Retrieve properties defined on the resource.
Method PROPPATCH(self, REQUEST, RESPONSE)
Set and/or remove properties defined on the resource.
Method PUT(self, REQUEST, RESPONSE)
Replace the GET response entity of an existing resource. Because this is often object-dependent, objects which handle PUT should override the default PUT implementation with an object-specific implementation. By default, PUT requests fail with a 405 (Method Not Allowed).
Method Publisher(self)
Lock   View
Dublin Core Publisher element - resource publisher.
Method Rights(self)
Lock   View
Dublin Core Rights element - resource copyright.
Method SecurityCheckPermission(md, permission, object)
Check whether the security context allows the given permission on the given object. Arguments: permission -- A permission name object -- The object being accessed according to the permission
Method Subject(self)
Lock   View
Dublin Core Subject element - resource keywords.
Method TRACE(self, REQUEST, RESPONSE)
Return the HTTP message received back to the client as the entity-body of a 200 (OK) response. This will often usually be intercepted by the web server in use. If not, the TRACE request will fail with a 405 (Method Not Allowed), since it is not often possible to reproduce the HTTP request verbatim from within the Zope environment.
Method Title(self)
Lock   View
Dublin Core Title element - resource name.
Method Type(self)
Lock   View
Dublin Core Type element - resource type.
Method UNLOCK(self, REQUEST, RESPONSE)
Remove an existing lock on a resource.
Method InitializeClass(self)
Method getPortalTypeName(self)
needed for the portal type view mechanism ...
Method wl_lockmapping(self, killinvalids=0, create=0)
if 'killinvalids' is 1, locks who are no longer valid will be deleted
Method absolute_url(self, relative=0)
Return the absolute URL of the object. This a canonical URL based on the object's physical containment path. It is affected by the virtual host configuration, if any, and can be used by external agents, such as a browser, to address the object. If the relative argument is provided, with a true value, then the value of virtual_url_path() is returned. Some Products incorrectly use '/'+absolute_url(1) as an absolute-path reference. This breaks in certain virtual hosting situations, and should be changed to use absolute_url_path() instead.
Method absolute_url_path(self)
Return the path portion of the absolute URL of the object. This includes the leading slash, and can be used as an 'absolute-path reference' as defined in RFC 2396.
Method ac_inherited_permissions(self, all=0)
Method access_debug_info(self)
Return debug info.
Method acquiredRolesAreUsedBy(self, permission)
Method actions(self)
Lock   View
return a list of valid transitions for the object
Method addCreator(self, creator=None)
Lock   Modify portal content
Add creator to Dublin Core creators.
Method bobobase_modification_time(self)
Method cb_isCopyable(self)
Method cb_isMoveable(self)
Method cb_userHasCopyOrMovePermission(self)
Method chains(self, wftool=None)
Lock   View management screens
return workflow chains
Method changeOwnership(self, user, recursive=0)
Change the ownership to the given user. If 'recursive' is true then also take ownership of all sub-objects, otherwise sub-objects retain their ownership information.
Method content_type(self)
WebDAV needs this to do the Right Thing (TM).
Method created(self)
Lock   View
Dublin Core Date element - date resource created.
Method dav__init(self, request, response)
Method dav__simpleifhandler(self, request, response, method='PUT', col=0, url=None, refresh=0)
Method dav__validate(self, object, methodname, REQUEST)
Method debugInfo(self)
Lock   View management screens
return tuple of sorted dict key, values
Method edit(self, title, member_id)
Method editMetadata(self, title='', subject=(), description='', contributors=(), effective_date=None, expiration_date=None, format='text/html', language='en-US', rights='')
Lock   Modify portal content
Need to add check for webDAV locked resource for TTW methods.
Method effective(self)
Lock   View
Dublin Core Date element - date resource becomes effective.
Method emptyContent(self)
initially dupe kupu into setting a blank field
Method expires(self)
Lock   View
Dublin Core Date element - date resource expires.
Method filtered_manage_options(self, REQUEST=None)
Method getActionInfo(self, action_chain, check_visibility=0, check_condition=0)
Get an Action info mapping specified by a chain of actions.
Method getActionsFor(self, workflow)
Lock   View management screens
return a list of valid transition states
Method getAllStatusIdsOf(self, workflow)
Lock   View management screens
return a list of valid state (ids) for the workflow
Method getAttribute(self, name)
Method getAttributeNode(self, name)
Method getAttributes(self)
Method getBastionDomain(self)
return a BastionDomain - DNS info for anything within a hosting context
Method getChildNodes(self)
Method getContentType(self, fieldname)
kupu get's confused with our non-AT types ...
Method getDefaultStatusOf(self, workflow)
Lock   View management screens
return the initial state of the workflow
Method getElementsByTagName(self, tagname)
Method getField(self, fieldname)
kupu get's confused with our non-AT types
Method getFirstChild(self)
Method icon(self, relative_to_portal=0)
Using this method allows the content class creator to grab icons on the fly instead of using a fixed attribute on the class.
Method getIconURL(self)
Get the absolute URL of the icon for the object.
Method getId(self)
Return the id of the object as a string. This method should be used in preference to accessing an id attribute of an object directly. The getId method is public.
Method getLastChild(self)
Method getMetadataHeaders(self)
Lock   View
Return RFC-822-style headers.
Method getNextSibling(self)
Method getNodeName(self)
Method getNodeType(self)
Method getNodeValue(self)
Method getOwner(self, info=0, aq_get=, UnownableOwner=[], getSecurityManager=)
Get the owner If a true argument is provided, then only the owner path and id are returned. Otherwise, the owner object is returned.
Method getOwnerDocument(self)
Method getOwnerTuple(self)
Return a tuple, (userdb_path, user_id) for the owner. o Ownership can be acquired, but only from the containment path. o If unowned, return None.
Method getParentNode(self)
Method getPath(self)
Lock   Access contents information
Method getPhysicalPath(self)
Method getPortalTypeName(self)
needed for the portal type view mechanism ...
Method getPreviousSibling(self)
Method getProperty(self, id, d=None)
Method getPropertyType(self, id)
Method getStatusOf(self, workflow, wftool=None, variable=None)
Lock   View management screens
return the status of ourselves in the context of this workflow (the corresponding WorkflowTool function is strangely declared private ...
Method getTagName(self)
Method getTypeInfo(self)
Lock   View
Get the TypeInformation object specified by the portal type.
Method getURL(self, relative=False)
Lock   Access contents information
Method getWrappedOwner(self)
Get the owner, modestly wrapped in the user folder. o If the object is not owned, return None. o If the owner's user database doesn't exist, return Nobody. o If the owner ID does not exist in the user database, return Nobody.
Method get_local_roles(self)
Method get_local_roles_for_userid(self, userid)
Method get_valid_userids(self)
Method hasChildNodes(self)
Method hasProperty(self, id)
Method has_local_roles(self)
Method html2pdf(self, html, encode=True)
return a pdf-representation of the html document, encode is to base64-encode
Method http__etag(self, readonly=0)
Method http__parseMatchList(self, REQUEST, header='if-match')
Method http__processMatchHeaders(self, REQUEST=None)
Method http__refreshEtag(self)
Method indexObject(self)
Lock   Modify portal content
Method isEffective(self, date)
Lock   View
Is the date within the resource's effective range?
Method json(self, only=None, exclude=None, **config)
return JSON representation of item
Method listContributors(self)
Lock   View
Dublin Core Contributor elements - resource collaborators.
Method listCreators(self)
Lock   View
List Dublin Core Creator elements - resource authors.
Method listDAVObjects(self)
Method manage(self, URL1)
Method manage_DAVget(self)
Gets the document source
Method manage_FTPlist(self, REQUEST)
Directory listing for FTP. In the case of non-Foldoid objects, the listing should contain one object, the object itself.
Method manage_FTPstat(self, REQUEST)
Psuedo stat, used by FTP for directory listings.
Method manage_access(self, REQUEST, **kw)
Lock   Change permissions
Return an interface for making permissions settings.
Method manage_acquiredPermissions(self, permissions=[], REQUEST=[])
Change the permissions that acquire.
Method manage_addLocalRoles(self, userid, roles, REQUEST=[])
Set local roles for a user.
Method manage_addProperty(self, id, value, type, REQUEST=None)
Add a new property via the web. Sets a new property with the given id, type, and value.
Method manage_afterAdd(self, item, container)
Method manage_afterClone(self, item)
Method manage_beforeDelete(self, item, container)
Method manage_changeOwnership(self, userid, recursive=0, REQUEST=None)
Lock   Take ownership
go change the owner to specified user (if found)
Method manage_changeOwnershipType(self, explicit=[], RESPONSE=[], REQUEST=[])
Lock   Take ownership
Change the type (implicit or explicit) of ownership.
Method manage_changePermissions(self, REQUEST)
Lock   Change permissions
Change all permissions settings, called by management screen.
Method manage_changeProperties(self, REQUEST=None, **kw)
Change existing object properties. Change object properties by passing either a REQUEST object or name=value parameters
Method manage_changePropertyTypes(self, old_ids, props, REQUEST=None)
Replace one set of properties with another Delete all properties that have ids in old_ids, then add a property for each item in props. Each item has a new_id, new_value, and new_type. The type of new_value should match new_type.
Method manage_changeStatus(self, wfid, action, REQUEST=None)
Lock   Manage properties
do a workflow transition from the ZMI
Method manage_debugDelAttrs(self, attrs, REQUEST=None)
Lock   Change configuration
remove attributes from object
Method manage_defined_roles(self, submit=None, REQUEST=None)
Called by management screen.
Method manage_delLocalRoles(self, userids, REQUEST=[])
Remove all local roles for a user.
Method manage_delProperties(self, ids=None, REQUEST=None)
Delete one or more properties specified by 'ids'.
Method manage_editMetadata(self, title, subject, description, contributors, effective_date, expiration_date, format, language, rights, REQUEST)
Lock   Modify portal content
Update metadata from the ZMI.
Method manage_editProperties(self, REQUEST)
Edit object properties via the web. The purpose of this method is to change all property values, even those not listed in REQUEST; otherwise checkboxes that get turned off will be ignored. Use manage_changeProperties() instead for most situations.
Method manage_editRoles(self, REQUEST, acl_type='A', acl_roles=[])
Method manage_editedDialog(self, REQUEST, **args)
Method manage_fixObjectCreated(self, REQUEST=None)
seems (indexable) stuff not created via _setObject doesn't get some necessary handlers called to setup uuid etc
Method manage_fixupOwnershipAfterAdd(self)
Method manage_forceStatus(self, wfid, state, REQUEST=None)
Lock   Manage properties
force a workflow transition
Method manage_getPermissionMapping(self)
Return the permission mapping for the object This is a list of dictionaries with: permission_name -- The name of the native object permission class_permission -- The class permission the permission is mapped to.
Method manage_getUserRolesAndPermissions(self, user_id)
Used for permission/role reporting for a given user_id. Returns a dict mapping 'user_defined_in' -> path where the user account is defined 'roles' -> global roles, 'roles_in_context' -> roles in context of the current object, 'allowed_permissions' -> permissions allowed for the user, 'disallowed_permissions' -> all other permissions
Method manage_oidSearch(self, oid)
Lock   View management screens
search for an OID (usually result of fsrefs) and identify the object
Method manage_permission(self, permission_to_manage, roles=[], acquire=[], REQUEST=[])
Change the settings for the given permission. If optional arg acquire is true, then the roles for the permission are acquired, in addition to the ones specified, otherwise the permissions are restricted to only the designated roles.
Method manage_ploneCatalog(self, REQUEST=None)
Lock   View management screens
add the damned thing into Plone so it appears in navigation ...
Method manage_repair(self, REQUEST=None)
fix up object upon schema change
Method manage_role(self, role_to_manage, permissions=[], REQUEST=[])
Change the permissions given to the given role.
Method manage_setLocalRoles(self, userid, roles, REQUEST=[])
Set local roles for a user.
Method manage_setPermissionMapping(self, permission_names=[], class_permissions=[], REQUEST=[])
Change the permission mapping
Method manage_takeOwnership(self, REQUEST, RESPONSE, recursive=[])
Lock   Take ownership
Take ownership (responsibility) for an object. If 'recursive' is true, then also take ownership of all sub-objects.
Method manage_undo_transactions(self, transaction_info=(), REQUEST=None)
Lock   Undo changes
Method manage_workspace(self, REQUEST)
Dispatch to first interface in manage_options
Method member_agents(self)
return a list of valid agent id's (ie one not containing yourself...)
Method modified(self)
Lock   View
Dublin Core Date element - date resource last modified.
Method notifyModified(self)
Take appropriate action after the resource has been modified. Update creators and modification_date.
Method notifyWorkflowCreated(self)
Notify the workflow that the object was just created.
Method objectValues(self, spec=None)
Method objectValues(self, spec=None)
Method objectValues(self, spec=None)
Method opaqueIds(self)
Return opaque ids (subelements that are contained using something that is not an ObjectManager).
Method opaqueItems(self)
Return opaque items (subelements that are contained using something that is not an ObjectManager).
Method opaqueValues(self)
Return opaque values (subelements that are contained using something that is not an ObjectManager).
Method owner_info(self)
Lock   View management screens
Get ownership info for display
Method permission_settings(self, permission=None)
Return user-role permission settings. If 'permission' is passed to the method then only the settings for 'permission' is returned.
Method permissionsOfRole(self, role)
Returns a role to permission mapping.
Method portalCatalogMe(self, REQUEST=None)
Lock   Modify portal content
stick object in portal catalog (sometimes we just internally catalog stuff but want navigation etc)
Method possible_permissions(self)
Method propdict(self)
Method propertyDescription(self, id)
Method propertyIds(self)
Method propertyItems(self)
Method propertyLabel(self, id)
Method propertyMap(self)
Method propertyValues(self)
Method publishTraverse(self, REQUEST, name)
This is copied from OFS/Application.py and seems strangely necessary since Plone 3.0 (to 4.3 at least) upgrade ... so that containers-as-attributes can be traversed ...
Method raise_standardErrorMessage(self, client=None, REQUEST={}, error_type=None, error_value=None, tb=None, error_tb=None, error_message='', tagSearch=, error_log_url='')
Method reindexObject(self, idxs=[])
Lock   Modify portal content
Reindex the object in the portal catalog.
Method reindexObjectSecurity(self, skip_self=False)
Lock   Modify portal content
Reindex security-related indexes on the object.
Method restrictedTraverse(self, path, default=)
Method rolesOfPermission(self, permission)
Returns a permission to role mapping.
Method setContributors(self, contributors)
Lock   Modify portal content
Set Dublin Core Contributor elements - resource collaborators.
Method setCreators(self, creators)
Lock   Modify portal content
Set Dublin Core Creator elements - resource authors.
Method setDescription(self, description)
Lock   Modify portal content
Set Dublin Core Description element - resource summary.
Method setEffectiveDate(self, effective_date)
Lock   Modify portal content
Set Dublin Core Date element - date resource becomes effective.
Method setExpirationDate(self, expiration_date)
Lock   Modify portal content
Set Dublin Core Date element - date resource expires.
Method setFormat(self, format)
Lock   Modify portal content
Set Dublin Core Format element - resource format.
Method setId(self, value)
Lock   Modify portal content
Sets the object id. - this is the Archetypes::BaseObject implementation ...
Method setLanguage(self, language)
Lock   Modify portal content
Set Dublin Core Language element - resource language.
Method setModificationDate(self, modification_date=None)
Lock   Modify portal content
Set the date when the resource was last modified. When called without an argument, sets the date to now.
Method setRights(self, rights)
Lock   Modify portal content
Set Dublin Core Rights element - resource copyright.
Method setSubject(self, subject)
Lock   Modify portal content
Set Dublin Core Subject element - resource keywords.
Method setTitle(self, title)
Lock   Modify portal content
Set Dublin Core Title element - resource name.
Method status(self, wftool=None, wf_var='review_state')
Lock   View
return workflow status
Method tabs_path_default(self, REQUEST, unquote=)
Method tabs_path_info(self, script, path, quote=)
Method this(self)
Method title_and_id(self)
Return the title if it is not blank and the id otherwise. If the title is not blank, then the id is included in parens.
Method title_or_id(self)
Return the title if it is not blank and the id otherwise.
Method tpURL(self)
Method tpValues(self)
Method undoable_transactions(self, first_transaction=None, last_transaction=None, PrincipiaUndoBatchSize=None)
Lock   Undo changes
Method unindexObject(self)
Lock   Modify portal content
Method unrestrictedTraverse(self, path, default=, restricted=False)
Lookup an object by path. path -- The path to the object. May be a sequence of strings or a slash separated string. If the path begins with an empty path element (i.e., an empty string or a slash) then the lookup is performed from the application root. Otherwise, the lookup is relative to self. Two dots (..) as a path element indicates an upward traversal to the acquisition parent. default -- If provided, this is the value returned if the path cannot be traversed for any reason (i.e., no object exists at that path or the object is inaccessible). restricted -- If false (default) then no security checking is performed. If true, then all of the objects along the path are validated with the security machinery. Usually invoked using restrictedTraverse().
Method userCanTakeOwnership(self)
Method userdefined_roles(self)
Return list of user-defined roles.
Method users_with_local_role(self, role)
Method valid_roles(self)
Return list of valid roles.
Method valid_property_id(self, id)
Method valid_roles(self)
Return list of valid roles.
Method validate_roles(self, roles)
Return true if all given roles are valid.
Method virtual_url_path(self)
Return a URL for the object, relative to the site root. If a virtual host is configured, the URL is a path relative to the virtual host's root object. Otherwise, it is the physical path. In either case, the URL does not begin with a slash.
Method wl_clearLocks(self)
Method wl_delLock(self, locktoken)
Method wl_getLock(self, locktoken)
Method wl_hasLock(self, token, killinvalids=0)
Method wl_isLocked(self)
Method wl_lockItems(self, killinvalids=0)
Method wl_lockTokens(self, killinvalids=0)
Method wl_lockValues(self, killinvalids=0)
Method wl_lockmapping(self, killinvalids=0, create=0)
if 'killinvalids' is 1, locks who are no longer valid will be deleted **Monkey patched by** 'plone.protect.monkey.wl_lockmapping'
Method wl_setLock(self, locktoken, lock)
Method workflowHistory(self, workflow)
Lock   View management screens
return the worflow history/transition info (latest first)
Functions
Function addCatalog (ob, event)
Function deleteCatalog (ob, event)
Function implements (*interfaces)
Declare interfaces implemented by instances of a class This function is called in a class definition. The arguments are one or more interfaces or interface specifications (`~zope.interface.interfaces.IDeclaration` objects). The interfaces given (including the interfaces in the specifications) are added to any interfaces previously declared. Previous declarations include declarations for base classes unless `implementsOnly` was used. This function is provided for convenience. It provides a more convenient way to call `classImplements`. For example:: implements(I1) is equivalent to calling:: classImplements(C, I1) after the class has been created.
Function manage_addRPMAgent (self, id, title='', member_id='', REQUEST=None)
Add a commission agent

Document Actions

Distributions
To see exactly what is included in BastionLinux™, visit our online RPMDistro Builder.
Buy Now
Bastion CD
Subscribe Now and get BastionLinux™ ...
Sponsored Links