nwo
stringlengths 6
76
| sha
stringlengths 40
40
| path
stringlengths 5
118
| language
stringclasses 1
value | identifier
stringlengths 1
89
| parameters
stringlengths 2
5.4k
| argument_list
stringclasses 1
value | return_statement
stringlengths 0
51.1k
| docstring
stringlengths 1
17.6k
| docstring_summary
stringlengths 0
7.02k
| docstring_tokens
sequence | function
stringlengths 30
51.1k
| function_tokens
sequence | url
stringlengths 85
218
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IOrderedContainer.moveObjectsUp | (ids, delta=1, subset_ids=None) | Move specified sub-objects up by delta in container.
If no delta is specified, delta is 1. See moveObjectsByDelta for more
details.
Permission -- Manage properties
Returns -- Number of moved sub-objects | Move specified sub-objects up by delta in container. | [
"Move",
"specified",
"sub",
"-",
"objects",
"up",
"by",
"delta",
"in",
"container",
"."
] | def moveObjectsUp(ids, delta=1, subset_ids=None):
""" Move specified sub-objects up by delta in container.
If no delta is specified, delta is 1. See moveObjectsByDelta for more
details.
Permission -- Manage properties
Returns -- Number of moved sub-objects
""" | [
"def",
"moveObjectsUp",
"(",
"ids",
",",
"delta",
"=",
"1",
",",
"subset_ids",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L62-L71 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IOrderedContainer.moveObjectsDown | (ids, delta=1, subset_ids=None) | Move specified sub-objects down by delta in container.
If no delta is specified, delta is 1. See moveObjectsByDelta for more
details.
Permission -- Manage properties
Returns -- Number of moved sub-objects | Move specified sub-objects down by delta in container. | [
"Move",
"specified",
"sub",
"-",
"objects",
"down",
"by",
"delta",
"in",
"container",
"."
] | def moveObjectsDown(ids, delta=1, subset_ids=None):
""" Move specified sub-objects down by delta in container.
If no delta is specified, delta is 1. See moveObjectsByDelta for more
details.
Permission -- Manage properties
Returns -- Number of moved sub-objects
""" | [
"def",
"moveObjectsDown",
"(",
"ids",
",",
"delta",
"=",
"1",
",",
"subset_ids",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L73-L82 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IOrderedContainer.moveObjectsToTop | (ids, subset_ids=None) | Move specified sub-objects to top of container.
See moveObjectsByDelta for more details.
Permission -- Manage properties
Returns -- Number of moved sub-objects | Move specified sub-objects to top of container. | [
"Move",
"specified",
"sub",
"-",
"objects",
"to",
"top",
"of",
"container",
"."
] | def moveObjectsToTop(ids, subset_ids=None):
""" Move specified sub-objects to top of container.
See moveObjectsByDelta for more details.
Permission -- Manage properties
Returns -- Number of moved sub-objects
""" | [
"def",
"moveObjectsToTop",
"(",
"ids",
",",
"subset_ids",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L84-L92 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IOrderedContainer.moveObjectsToBottom | (ids, subset_ids=None) | Move specified sub-objects to bottom of container.
See moveObjectsByDelta for more details.
Permission -- Manage properties
Returns -- Number of moved sub-objects | Move specified sub-objects to bottom of container. | [
"Move",
"specified",
"sub",
"-",
"objects",
"to",
"bottom",
"of",
"container",
"."
] | def moveObjectsToBottom(ids, subset_ids=None):
""" Move specified sub-objects to bottom of container.
See moveObjectsByDelta for more details.
Permission -- Manage properties
Returns -- Number of moved sub-objects
""" | [
"def",
"moveObjectsToBottom",
"(",
"ids",
",",
"subset_ids",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L94-L102 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IOrderedContainer.orderObjects | (key, reverse=None) | Order sub-objects by key and direction.
Permission -- Manage properties
Returns -- Number of moved sub-objects | Order sub-objects by key and direction. | [
"Order",
"sub",
"-",
"objects",
"by",
"key",
"and",
"direction",
"."
] | def orderObjects(key, reverse=None):
""" Order sub-objects by key and direction.
Permission -- Manage properties
Returns -- Number of moved sub-objects
""" | [
"def",
"orderObjects",
"(",
"key",
",",
"reverse",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L104-L110 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IOrderedContainer.getObjectPosition | (id) | Get the position of an object by its id.
Permission -- Access contents information
Returns -- Position | Get the position of an object by its id. | [
"Get",
"the",
"position",
"of",
"an",
"object",
"by",
"its",
"id",
"."
] | def getObjectPosition(id):
""" Get the position of an object by its id.
Permission -- Access contents information
Returns -- Position
""" | [
"def",
"getObjectPosition",
"(",
"id",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L112-L118 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IOrderedContainer.moveObjectToPosition | (id, position) | Move specified object to absolute position.
Permission -- Manage properties
Returns -- Number of moved sub-objects | Move specified object to absolute position. | [
"Move",
"specified",
"object",
"to",
"absolute",
"position",
"."
] | def moveObjectToPosition(id, position):
""" Move specified object to absolute position.
Permission -- Manage properties
Returns -- Number of moved sub-objects
""" | [
"def",
"moveObjectToPosition",
"(",
"id",
",",
"position",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L120-L126 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ICopySource._canCopy | (op=0) | Called to make sure this object is copyable.
The op var is 0 for a copy, 1 for a move. | Called to make sure this object is copyable. | [
"Called",
"to",
"make",
"sure",
"this",
"object",
"is",
"copyable",
"."
] | def _canCopy(op=0):
"""Called to make sure this object is copyable.
The op var is 0 for a copy, 1 for a move.
""" | [
"def",
"_canCopy",
"(",
"op",
"=",
"0",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L136-L140 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ICopySource._notifyOfCopyTo | (container, op=0) | Overide this to be pickly about where you go!
If you dont want to go there, raise an exception. The op variable is 0
for a copy, 1 for a move. | Overide this to be pickly about where you go! | [
"Overide",
"this",
"to",
"be",
"pickly",
"about",
"where",
"you",
"go!"
] | def _notifyOfCopyTo(container, op=0):
"""Overide this to be pickly about where you go!
If you dont want to go there, raise an exception. The op variable is 0
for a copy, 1 for a move.
""" | [
"def",
"_notifyOfCopyTo",
"(",
"container",
",",
"op",
"=",
"0",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L142-L147 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ICopySource._postCopy | (container, op=0) | Called after the copy is finished to accomodate special cases.
The op var is 0 for a copy, 1 for a move. | Called after the copy is finished to accomodate special cases.
The op var is 0 for a copy, 1 for a move. | [
"Called",
"after",
"the",
"copy",
"is",
"finished",
"to",
"accomodate",
"special",
"cases",
".",
"The",
"op",
"var",
"is",
"0",
"for",
"a",
"copy",
"1",
"for",
"a",
"move",
"."
] | def _postCopy(container, op=0):
"""Called after the copy is finished to accomodate special cases.
The op var is 0 for a copy, 1 for a move.
""" | [
"def",
"_postCopy",
"(",
"container",
",",
"op",
"=",
"0",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L153-L156 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ICopySource._setId | (id) | Called to set the new id of a copied object. | Called to set the new id of a copied object. | [
"Called",
"to",
"set",
"the",
"new",
"id",
"of",
"a",
"copied",
"object",
"."
] | def _setId(id):
"""Called to set the new id of a copied object.
""" | [
"def",
"_setId",
"(",
"id",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L158-L160 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ICopySource.cb_isCopyable | () | Is object copyable? Returns 0 or 1 | Is object copyable? Returns 0 or 1 | [
"Is",
"object",
"copyable?",
"Returns",
"0",
"or",
"1"
] | def cb_isCopyable():
"""Is object copyable? Returns 0 or 1
""" | [
"def",
"cb_isCopyable",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L162-L164 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ICopySource.cb_isMoveable | () | Is object moveable? Returns 0 or 1 | Is object moveable? Returns 0 or 1 | [
"Is",
"object",
"moveable?",
"Returns",
"0",
"or",
"1"
] | def cb_isMoveable():
"""Is object moveable? Returns 0 or 1
""" | [
"def",
"cb_isMoveable",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L166-L168 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ITraversable.absolute_url | (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. | Return the absolute URL of the object. | [
"Return",
"the",
"absolute",
"URL",
"of",
"the",
"object",
"."
] | def absolute_url(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.
""" | [
"def",
"absolute_url",
"(",
"relative",
"=",
"0",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L180-L195 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ITraversable.absolute_url_path | () | 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. | Return the path portion of the absolute URL of the object. | [
"Return",
"the",
"path",
"portion",
"of",
"the",
"absolute",
"URL",
"of",
"the",
"object",
"."
] | def absolute_url_path():
"""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.
""" | [
"def",
"absolute_url_path",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L197-L202 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ITraversable.virtual_url_path | () | 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. | Return a URL for the object, relative to the site root. | [
"Return",
"a",
"URL",
"for",
"the",
"object",
"relative",
"to",
"the",
"site",
"root",
"."
] | def virtual_url_path():
"""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.
""" | [
"def",
"virtual_url_path",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L204-L210 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ITraversable.getPhysicalPath | () | Get the physical path of the object.
Returns a path (an immutable sequence of strings) that can be used to
access this object again later, for example in a copy/paste operation.
getPhysicalRoot() and getPhysicalPath() are designed to operate
together. | Get the physical path of the object. | [
"Get",
"the",
"physical",
"path",
"of",
"the",
"object",
"."
] | def getPhysicalPath():
"""Get the physical path of the object.
Returns a path (an immutable sequence of strings) that can be used to
access this object again later, for example in a copy/paste operation.
getPhysicalRoot() and getPhysicalPath() are designed to operate
together.
""" | [
"def",
"getPhysicalPath",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L212-L219 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ITraversable.unrestrictedTraverse | (path, default=None, restricted=0) | 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(). | Lookup an object by path. | [
"Lookup",
"an",
"object",
"by",
"path",
"."
] | def unrestrictedTraverse(path, default=None, restricted=0):
"""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().
""" | [
"def",
"unrestrictedTraverse",
"(",
"path",
",",
"default",
"=",
"None",
",",
"restricted",
"=",
"0",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L221-L239 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ITraversable.restrictedTraverse | (path, default=None) | Trusted code traversal code, always enforces security. | Trusted code traversal code, always enforces security. | [
"Trusted",
"code",
"traversal",
"code",
"always",
"enforces",
"security",
"."
] | def restrictedTraverse(path, default=None):
"""Trusted code traversal code, always enforces security.
""" | [
"def",
"restrictedTraverse",
"(",
"path",
",",
"default",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L241-L243 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IManageable.manage | (URL1) | Show management screen | Show management screen | [
"Show",
"management",
"screen"
] | def manage(URL1):
"""Show management screen""" | [
"def",
"manage",
"(",
"URL1",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L273-L274 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IManageable.manage_afterAdd | (item, container) | Gets called after being added to a container | Gets called after being added to a container | [
"Gets",
"called",
"after",
"being",
"added",
"to",
"a",
"container"
] | def manage_afterAdd(item, container):
"""Gets called after being added to a container""" | [
"def",
"manage_afterAdd",
"(",
"item",
",",
"container",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L276-L277 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IManageable.manage_beforeDelete | (item, container) | Gets called before being deleted | Gets called before being deleted | [
"Gets",
"called",
"before",
"being",
"deleted"
] | def manage_beforeDelete(item, container):
"""Gets called before being deleted""" | [
"def",
"manage_beforeDelete",
"(",
"item",
",",
"container",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L279-L280 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IManageable.manage_afterClone | (item) | Gets called after being cloned | Gets called after being cloned | [
"Gets",
"called",
"after",
"being",
"cloned"
] | def manage_afterClone(item):
"""Gets called after being cloned""" | [
"def",
"manage_afterClone",
"(",
"item",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L282-L283 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IManageable.manage_workspace | (REQUEST) | Dispatch to first interface in manage_options | Dispatch to first interface in manage_options | [
"Dispatch",
"to",
"first",
"interface",
"in",
"manage_options"
] | def manage_workspace(REQUEST):
"""Dispatch to first interface in manage_options
""" | [
"def",
"manage_workspace",
"(",
"REQUEST",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L289-L291 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IWriteLock.wl_lockItems | (killinvalids=0) | Returns (key, value) pairs of locktoken, lock.
if 'killinvalids' is true, invalid locks (locks whose timeout
has been exceeded) will be deleted | Returns (key, value) pairs of locktoken, lock. | [
"Returns",
"(",
"key",
"value",
")",
"pairs",
"of",
"locktoken",
"lock",
"."
] | def wl_lockItems(killinvalids=0):
""" Returns (key, value) pairs of locktoken, lock.
if 'killinvalids' is true, invalid locks (locks whose timeout
has been exceeded) will be deleted""" | [
"def",
"wl_lockItems",
"(",
"killinvalids",
"=",
"0",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L333-L337 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IWriteLock.wl_lockValues | (killinvalids=0) | Returns a sequence of locks. if 'killinvalids' is true,
invalid locks will be deleted | Returns a sequence of locks. if 'killinvalids' is true,
invalid locks will be deleted | [
"Returns",
"a",
"sequence",
"of",
"locks",
".",
"if",
"killinvalids",
"is",
"true",
"invalid",
"locks",
"will",
"be",
"deleted"
] | def wl_lockValues(killinvalids=0):
""" Returns a sequence of locks. if 'killinvalids' is true,
invalid locks will be deleted""" | [
"def",
"wl_lockValues",
"(",
"killinvalids",
"=",
"0",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L339-L341 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IWriteLock.wl_lockTokens | (killinvalids=0) | Returns a sequence of lock tokens. if 'killinvalids' is true,
invalid locks will be deleted | Returns a sequence of lock tokens. if 'killinvalids' is true,
invalid locks will be deleted | [
"Returns",
"a",
"sequence",
"of",
"lock",
"tokens",
".",
"if",
"killinvalids",
"is",
"true",
"invalid",
"locks",
"will",
"be",
"deleted"
] | def wl_lockTokens(killinvalids=0):
""" Returns a sequence of lock tokens. if 'killinvalids' is true,
invalid locks will be deleted""" | [
"def",
"wl_lockTokens",
"(",
"killinvalids",
"=",
"0",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L343-L345 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IWriteLock.wl_hasLock | (token, killinvalids=0) | Returns true if the lock identified by the token is attached
to the object. | Returns true if the lock identified by the token is attached
to the object. | [
"Returns",
"true",
"if",
"the",
"lock",
"identified",
"by",
"the",
"token",
"is",
"attached",
"to",
"the",
"object",
"."
] | def wl_hasLock(token, killinvalids=0):
""" Returns true if the lock identified by the token is attached
to the object. """ | [
"def",
"wl_hasLock",
"(",
"token",
",",
"killinvalids",
"=",
"0",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L347-L349 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IWriteLock.wl_isLocked | () | Returns true if 'self' is locked at all. If invalid locks
still exist, they should be deleted. | Returns true if 'self' is locked at all. If invalid locks
still exist, they should be deleted. | [
"Returns",
"true",
"if",
"self",
"is",
"locked",
"at",
"all",
".",
"If",
"invalid",
"locks",
"still",
"exist",
"they",
"should",
"be",
"deleted",
"."
] | def wl_isLocked():
""" Returns true if 'self' is locked at all. If invalid locks
still exist, they should be deleted.""" | [
"def",
"wl_isLocked",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L351-L353 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IWriteLock.wl_setLock | (locktoken, lock) | Store the LockItem, 'lock'. The locktoken will be used to fetch
and delete the lock. If the lock exists, this MUST
overwrite it if all of the values except for the 'timeout' on the
old and new lock are the same. | Store the LockItem, 'lock'. The locktoken will be used to fetch
and delete the lock. If the lock exists, this MUST
overwrite it if all of the values except for the 'timeout' on the
old and new lock are the same. | [
"Store",
"the",
"LockItem",
"lock",
".",
"The",
"locktoken",
"will",
"be",
"used",
"to",
"fetch",
"and",
"delete",
"the",
"lock",
".",
"If",
"the",
"lock",
"exists",
"this",
"MUST",
"overwrite",
"it",
"if",
"all",
"of",
"the",
"values",
"except",
"for",
"the",
"timeout",
"on",
"the",
"old",
"and",
"new",
"lock",
"are",
"the",
"same",
"."
] | def wl_setLock(locktoken, lock):
""" Store the LockItem, 'lock'. The locktoken will be used to fetch
and delete the lock. If the lock exists, this MUST
overwrite it if all of the values except for the 'timeout' on the
old and new lock are the same. """ | [
"def",
"wl_setLock",
"(",
"locktoken",
",",
"lock",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L355-L359 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IWriteLock.wl_getLock | (locktoken) | Returns the locktoken identified by the locktokenuri | Returns the locktoken identified by the locktokenuri | [
"Returns",
"the",
"locktoken",
"identified",
"by",
"the",
"locktokenuri"
] | def wl_getLock(locktoken):
""" Returns the locktoken identified by the locktokenuri """ | [
"def",
"wl_getLock",
"(",
"locktoken",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L361-L362 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IWriteLock.wl_delLock | (locktoken) | Deletes the locktoken identified by the locktokenuri | Deletes the locktoken identified by the locktokenuri | [
"Deletes",
"the",
"locktoken",
"identified",
"by",
"the",
"locktokenuri"
] | def wl_delLock(locktoken):
""" Deletes the locktoken identified by the locktokenuri """ | [
"def",
"wl_delLock",
"(",
"locktoken",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L364-L365 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IWriteLock.wl_clearLocks | () | Deletes ALL locks on the object - should only be called
by lock management machinery. | Deletes ALL locks on the object - should only be called
by lock management machinery. | [
"Deletes",
"ALL",
"locks",
"on",
"the",
"object",
"-",
"should",
"only",
"be",
"called",
"by",
"lock",
"management",
"machinery",
"."
] | def wl_clearLocks():
""" Deletes ALL locks on the object - should only be called
by lock management machinery. """ | [
"def",
"wl_clearLocks",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L367-L369 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ILockItem.__init__ | (creator, owner, depth=0, timeout='Infinity',
locktype='write', lockscope='exclusive', token=None) | \
If any of the following are untrue, a **ValueError** exception
will be raised.
- **creator** MUST be a Zope user object or string to find a
valid user object.
- **owner** MUST be a nonempty string, or type that can be converted
to a nonempty string.
- **depth** MUST be in the set {0,'infinity'}
- **timeout** MUST either be an integer, or a string in the form
of 'Seconds-nnn' where nnn is an integer. The timeout value
MUST be less than (2^32)-1. *IF* timeout is the string value
'Infinite', the timeout value will be set to 1800 (30 minutes).
(Timeout is the value in seconds from creation/modification
time until the lock MAY time out).
- **locktype** not in set {'write'} *this may expand later*
- **lockscope** not in set {'exclusive'} *this may expand later*
If the value passed in to 'token' is 'None', the a new locktoken
will be generated during the construction process.
__init__ must generate the opaquelocktoken uri used to identify the
lock (if 'token' is 'None')and set all of the above attributes on
the object. | \
If any of the following are untrue, a **ValueError** exception
will be raised. | [
"\\",
"If",
"any",
"of",
"the",
"following",
"are",
"untrue",
"a",
"**",
"ValueError",
"**",
"exception",
"will",
"be",
"raised",
"."
] | def __init__(creator, owner, depth=0, timeout='Infinity',
locktype='write', lockscope='exclusive', token=None):
"""\
If any of the following are untrue, a **ValueError** exception
will be raised.
- **creator** MUST be a Zope user object or string to find a
valid user object.
- **owner** MUST be a nonempty string, or type that can be converted
to a nonempty string.
- **depth** MUST be in the set {0,'infinity'}
- **timeout** MUST either be an integer, or a string in the form
of 'Seconds-nnn' where nnn is an integer. The timeout value
MUST be less than (2^32)-1. *IF* timeout is the string value
'Infinite', the timeout value will be set to 1800 (30 minutes).
(Timeout is the value in seconds from creation/modification
time until the lock MAY time out).
- **locktype** not in set {'write'} *this may expand later*
- **lockscope** not in set {'exclusive'} *this may expand later*
If the value passed in to 'token' is 'None', the a new locktoken
will be generated during the construction process.
__init__ must generate the opaquelocktoken uri used to identify the
lock (if 'token' is 'None')and set all of the above attributes on
the object.
""" | [
"def",
"__init__",
"(",
"creator",
",",
"owner",
",",
"depth",
"=",
"0",
",",
"timeout",
"=",
"'Infinity'",
",",
"locktype",
"=",
"'write'",
",",
"lockscope",
"=",
"'exclusive'",
",",
"token",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L395-L426 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ILockItem.getCreator | () | Returns the Zope user who created the lock. This is returned
in a tuple containing the Users ID and the path to the user folder
they came from. | Returns the Zope user who created the lock. This is returned
in a tuple containing the Users ID and the path to the user folder
they came from. | [
"Returns",
"the",
"Zope",
"user",
"who",
"created",
"the",
"lock",
".",
"This",
"is",
"returned",
"in",
"a",
"tuple",
"containing",
"the",
"Users",
"ID",
"and",
"the",
"path",
"to",
"the",
"user",
"folder",
"they",
"came",
"from",
"."
] | def getCreator():
""" Returns the Zope user who created the lock. This is returned
in a tuple containing the Users ID and the path to the user folder
they came from.""" | [
"def",
"getCreator",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L428-L431 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ILockItem.getCreatorPath | () | Returns a string of the path to the user object in the user
folder they were found in. | Returns a string of the path to the user object in the user
folder they were found in. | [
"Returns",
"a",
"string",
"of",
"the",
"path",
"to",
"the",
"user",
"object",
"in",
"the",
"user",
"folder",
"they",
"were",
"found",
"in",
"."
] | def getCreatorPath():
""" Returns a string of the path to the user object in the user
folder they were found in. """ | [
"def",
"getCreatorPath",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L433-L435 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ILockItem.getOwner | () | Returns the string value of the 'owner' property sent
in by WebDAV | Returns the string value of the 'owner' property sent
in by WebDAV | [
"Returns",
"the",
"string",
"value",
"of",
"the",
"owner",
"property",
"sent",
"in",
"by",
"WebDAV"
] | def getOwner():
""" Returns the string value of the 'owner' property sent
in by WebDAV """ | [
"def",
"getOwner",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L437-L439 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ILockItem.getLockToken | () | returns the opaque lock token | returns the opaque lock token | [
"returns",
"the",
"opaque",
"lock",
"token"
] | def getLockToken():
""" returns the opaque lock token """ | [
"def",
"getLockToken",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L441-L442 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ILockItem.getDepth | () | returns the depth of the lock | returns the depth of the lock | [
"returns",
"the",
"depth",
"of",
"the",
"lock"
] | def getDepth():
""" returns the depth of the lock """ | [
"def",
"getDepth",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L444-L445 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ILockItem.getTimeout | () | returns an integer value of the timeout setting | returns an integer value of the timeout setting | [
"returns",
"an",
"integer",
"value",
"of",
"the",
"timeout",
"setting"
] | def getTimeout():
""" returns an integer value of the timeout setting """ | [
"def",
"getTimeout",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L447-L448 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ILockItem.getTimeoutString | () | returns the timeout value in a form acceptable by
WebDAV (ie - 'Seconds-40800') | returns the timeout value in a form acceptable by
WebDAV (ie - 'Seconds-40800') | [
"returns",
"the",
"timeout",
"value",
"in",
"a",
"form",
"acceptable",
"by",
"WebDAV",
"(",
"ie",
"-",
"Seconds",
"-",
"40800",
")"
] | def getTimeoutString():
""" returns the timeout value in a form acceptable by
WebDAV (ie - 'Seconds-40800') """ | [
"def",
"getTimeoutString",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L450-L452 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ILockItem.setTimeout | (newtimeout) | refreshes the timeout information | refreshes the timeout information | [
"refreshes",
"the",
"timeout",
"information"
] | def setTimeout(newtimeout):
""" refreshes the timeout information """ | [
"def",
"setTimeout",
"(",
"newtimeout",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L454-L455 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ILockItem.getModifiedTime | () | returns a time.time value of the last time the Lock was
modified. From RFC 2518:
The timeout counter SHOULD be restarted any time an owner of the
lock sends a method to any member of the lock, including unsupported
methods or methods which are unsucscessful. The lock MUST be
refreshed if a refresh LOCK method is successfully received.
The modified time is used to calculate the refreshed value | returns a time.time value of the last time the Lock was
modified. From RFC 2518: | [
"returns",
"a",
"time",
".",
"time",
"value",
"of",
"the",
"last",
"time",
"the",
"Lock",
"was",
"modified",
".",
"From",
"RFC",
"2518",
":"
] | def getModifiedTime():
""" returns a time.time value of the last time the Lock was
modified. From RFC 2518:
The timeout counter SHOULD be restarted any time an owner of the
lock sends a method to any member of the lock, including unsupported
methods or methods which are unsucscessful. The lock MUST be
refreshed if a refresh LOCK method is successfully received.
The modified time is used to calculate the refreshed value """ | [
"def",
"getModifiedTime",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L457-L466 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ILockItem.refresh | () | Tickles the locks modified time by setting it to the current
time.time() value. (As stated in the RFC, the timeout counter
SHOULD be restarted for any HTTP method called by the lock owner
on the locked object). | Tickles the locks modified time by setting it to the current
time.time() value. (As stated in the RFC, the timeout counter
SHOULD be restarted for any HTTP method called by the lock owner
on the locked object). | [
"Tickles",
"the",
"locks",
"modified",
"time",
"by",
"setting",
"it",
"to",
"the",
"current",
"time",
".",
"time",
"()",
"value",
".",
"(",
"As",
"stated",
"in",
"the",
"RFC",
"the",
"timeout",
"counter",
"SHOULD",
"be",
"restarted",
"for",
"any",
"HTTP",
"method",
"called",
"by",
"the",
"lock",
"owner",
"on",
"the",
"locked",
"object",
")",
"."
] | def refresh():
""" Tickles the locks modified time by setting it to the current
time.time() value. (As stated in the RFC, the timeout counter
SHOULD be restarted for any HTTP method called by the lock owner
on the locked object). """ | [
"def",
"refresh",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L468-L472 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ILockItem.isValid | () | Returns true if (self.getModifiedTime() + self.getTimeout())
is greater than the current time.time() value. | Returns true if (self.getModifiedTime() + self.getTimeout())
is greater than the current time.time() value. | [
"Returns",
"true",
"if",
"(",
"self",
".",
"getModifiedTime",
"()",
"+",
"self",
".",
"getTimeout",
"()",
")",
"is",
"greater",
"than",
"the",
"current",
"time",
".",
"time",
"()",
"value",
"."
] | def isValid():
""" Returns true if (self.getModifiedTime() + self.getTimeout())
is greater than the current time.time() value. """ | [
"def",
"isValid",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L474-L476 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ILockItem.getLockType | () | returns the lock type ('write') | returns the lock type ('write') | [
"returns",
"the",
"lock",
"type",
"(",
"write",
")"
] | def getLockType():
""" returns the lock type ('write') """ | [
"def",
"getLockType",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L483-L484 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ILockItem.getLockScope | () | returns the lock scope ('exclusive') | returns the lock scope ('exclusive') | [
"returns",
"the",
"lock",
"scope",
"(",
"exclusive",
")"
] | def getLockScope():
""" returns the lock scope ('exclusive') """ | [
"def",
"getLockScope",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L486-L487 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ILockItem.asLockDiscoveryProperty | (ns='d') | Return the lock rendered as an XML representation of a
WebDAV 'lockdiscovery' property. 'ns' is the namespace identifier
used on the XML elements. | Return the lock rendered as an XML representation of a
WebDAV 'lockdiscovery' property. 'ns' is the namespace identifier
used on the XML elements. | [
"Return",
"the",
"lock",
"rendered",
"as",
"an",
"XML",
"representation",
"of",
"a",
"WebDAV",
"lockdiscovery",
"property",
".",
"ns",
"is",
"the",
"namespace",
"identifier",
"used",
"on",
"the",
"XML",
"elements",
"."
] | def asLockDiscoveryProperty(ns='d'):
""" Return the lock rendered as an XML representation of a
WebDAV 'lockdiscovery' property. 'ns' is the namespace identifier
used on the XML elements.""" | [
"def",
"asLockDiscoveryProperty",
"(",
"ns",
"=",
"'d'",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L489-L492 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ILockItem.asXML | () | Render a full XML representation of a lock for WebDAV,
used when returning the value of a newly created lock. | Render a full XML representation of a lock for WebDAV,
used when returning the value of a newly created lock. | [
"Render",
"a",
"full",
"XML",
"representation",
"of",
"a",
"lock",
"for",
"WebDAV",
"used",
"when",
"returning",
"the",
"value",
"of",
"a",
"newly",
"created",
"lock",
"."
] | def asXML():
""" Render a full XML representation of a lock for WebDAV,
used when returning the value of a newly created lock. """ | [
"def",
"asXML",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L494-L496 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IItem.getId | () | 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. | Return the id of the object as a string. | [
"Return",
"the",
"id",
"of",
"the",
"object",
"as",
"a",
"string",
"."
] | def getId():
"""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.
""" | [
"def",
"getId",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L509-L514 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IItem.title_or_id | () | Return the title if it is not blank and the id otherwise. | Return the title if it is not blank and the id otherwise. | [
"Return",
"the",
"title",
"if",
"it",
"is",
"not",
"blank",
"and",
"the",
"id",
"otherwise",
"."
] | def title_or_id():
"""Return the title if it is not blank and the id otherwise.
""" | [
"def",
"title_or_id",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L516-L518 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IItem.title_and_id | () | 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. | Return the title if it is not blank and the id otherwise. | [
"Return",
"the",
"title",
"if",
"it",
"is",
"not",
"blank",
"and",
"the",
"id",
"otherwise",
"."
] | def title_and_id():
"""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.
""" | [
"def",
"title_and_id",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L520-L524 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IItem.manage_editedDialog | (REQUEST, **args) | Show an 'edited' dialog. | Show an 'edited' dialog. | [
"Show",
"an",
"edited",
"dialog",
"."
] | def manage_editedDialog(REQUEST, **args):
"""Show an 'edited' dialog.
""" | [
"def",
"manage_editedDialog",
"(",
"REQUEST",
",",
"*",
"*",
"args",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L526-L528 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IItem.raise_standardErrorMessage | (client=None, REQUEST={},
error_type=None, error_value=None, tb=None,
error_tb=None, error_message='',
tagSearch=None, error_log_url='') | Raise standard error message. | Raise standard error message. | [
"Raise",
"standard",
"error",
"message",
"."
] | def raise_standardErrorMessage(client=None, REQUEST={},
error_type=None, error_value=None, tb=None,
error_tb=None, error_message='',
tagSearch=None, error_log_url=''):
"""Raise standard error message.
""" | [
"def",
"raise_standardErrorMessage",
"(",
"client",
"=",
"None",
",",
"REQUEST",
"=",
"{",
"}",
",",
"error_type",
"=",
"None",
",",
"error_value",
"=",
"None",
",",
"tb",
"=",
"None",
",",
"error_tb",
"=",
"None",
",",
"error_message",
"=",
"''",
",",
"tagSearch",
"=",
"None",
",",
"error_log_url",
"=",
"''",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L530-L535 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ICopyContainer.manage_cutObjects | (ids=None, REQUEST=None) | Put a reference to the objects named in ids in the clip board | Put a reference to the objects named in ids in the clip board | [
"Put",
"a",
"reference",
"to",
"the",
"objects",
"named",
"in",
"ids",
"in",
"the",
"clip",
"board"
] | def manage_cutObjects(ids=None, REQUEST=None):
"""Put a reference to the objects named in ids in the clip board""" | [
"def",
"manage_cutObjects",
"(",
"ids",
"=",
"None",
",",
"REQUEST",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L581-L582 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ICopyContainer.manage_copyObjects | (ids=None, REQUEST=None, RESPONSE=None) | Put a reference to the objects named in ids in the clip board | Put a reference to the objects named in ids in the clip board | [
"Put",
"a",
"reference",
"to",
"the",
"objects",
"named",
"in",
"ids",
"in",
"the",
"clip",
"board"
] | def manage_copyObjects(ids=None, REQUEST=None, RESPONSE=None):
"""Put a reference to the objects named in ids in the clip board""" | [
"def",
"manage_copyObjects",
"(",
"ids",
"=",
"None",
",",
"REQUEST",
"=",
"None",
",",
"RESPONSE",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L584-L585 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ICopyContainer._get_id | (id) | Allow containers to override the generation of object copy id by
attempting to call its _get_id method, if it exists. | Allow containers to override the generation of object copy id by
attempting to call its _get_id method, if it exists. | [
"Allow",
"containers",
"to",
"override",
"the",
"generation",
"of",
"object",
"copy",
"id",
"by",
"attempting",
"to",
"call",
"its",
"_get_id",
"method",
"if",
"it",
"exists",
"."
] | def _get_id(id):
"""Allow containers to override the generation of object copy id by
attempting to call its _get_id method, if it exists.
""" | [
"def",
"_get_id",
"(",
"id",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L587-L590 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ICopyContainer.manage_pasteObjects | (cb_copy_data=None, REQUEST=None) | Paste previously copied objects into the current object.
If calling manage_pasteObjects from python code, pass the result of a
previous call to manage_cutObjects or manage_copyObjects as the first
argument. | Paste previously copied objects into the current object. | [
"Paste",
"previously",
"copied",
"objects",
"into",
"the",
"current",
"object",
"."
] | def manage_pasteObjects(cb_copy_data=None, REQUEST=None):
"""Paste previously copied objects into the current object.
If calling manage_pasteObjects from python code, pass the result of a
previous call to manage_cutObjects or manage_copyObjects as the first
argument.
""" | [
"def",
"manage_pasteObjects",
"(",
"cb_copy_data",
"=",
"None",
",",
"REQUEST",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L592-L598 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ICopyContainer.manage_renameObjects | (ids=[], new_ids=[], REQUEST=None) | Rename several sub-objects | Rename several sub-objects | [
"Rename",
"several",
"sub",
"-",
"objects"
] | def manage_renameObjects(ids=[], new_ids=[], REQUEST=None):
"""Rename several sub-objects""" | [
"def",
"manage_renameObjects",
"(",
"ids",
"=",
"[",
"]",
",",
"new_ids",
"=",
"[",
"]",
",",
"REQUEST",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L602-L603 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ICopyContainer.manage_renameObject | (id, new_id, REQUEST=None) | Rename a particular sub-object | Rename a particular sub-object | [
"Rename",
"a",
"particular",
"sub",
"-",
"object"
] | def manage_renameObject(id, new_id, REQUEST=None):
"""Rename a particular sub-object""" | [
"def",
"manage_renameObject",
"(",
"id",
",",
"new_id",
",",
"REQUEST",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L605-L606 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ICopyContainer.manage_clone | (ob, id, REQUEST=None) | Clone an object, creating a new object with the given id. | Clone an object, creating a new object with the given id. | [
"Clone",
"an",
"object",
"creating",
"a",
"new",
"object",
"with",
"the",
"given",
"id",
"."
] | def manage_clone(ob, id, REQUEST=None):
"""Clone an object, creating a new object with the given id.
""" | [
"def",
"manage_clone",
"(",
"ob",
",",
"id",
",",
"REQUEST",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L608-L610 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ICopyContainer.cb_dataValid | () | Return true if clipboard data seems valid. | Return true if clipboard data seems valid. | [
"Return",
"true",
"if",
"clipboard",
"data",
"seems",
"valid",
"."
] | def cb_dataValid():
"""Return true if clipboard data seems valid.
""" | [
"def",
"cb_dataValid",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L612-L614 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ICopyContainer.cb_dataItems | () | List of objects in the clip board. | List of objects in the clip board. | [
"List",
"of",
"objects",
"in",
"the",
"clip",
"board",
"."
] | def cb_dataItems():
"""List of objects in the clip board.
""" | [
"def",
"cb_dataItems",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L616-L618 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | ICopyContainer._verifyObjectPaste | (object, validate_src=1) | Verify whether the current user is allowed to paste the passed
object into self. This is determined by checking to see if the
user could create a new object of the same meta_type of the
object passed in and checking that the user actually is
allowed to access the passed in object in its existing
context.
Passing a false value for the validate_src argument will skip
checking the passed in object in its existing context. This is
mainly useful for situations where the passed in object has no
existing context, such as checking an object during an import
(the object will not yet have been connected to the
acquisition hierarchy). | Verify whether the current user is allowed to paste the passed
object into self. This is determined by checking to see if the
user could create a new object of the same meta_type of the
object passed in and checking that the user actually is
allowed to access the passed in object in its existing
context. | [
"Verify",
"whether",
"the",
"current",
"user",
"is",
"allowed",
"to",
"paste",
"the",
"passed",
"object",
"into",
"self",
".",
"This",
"is",
"determined",
"by",
"checking",
"to",
"see",
"if",
"the",
"user",
"could",
"create",
"a",
"new",
"object",
"of",
"the",
"same",
"meta_type",
"of",
"the",
"object",
"passed",
"in",
"and",
"checking",
"that",
"the",
"user",
"actually",
"is",
"allowed",
"to",
"access",
"the",
"passed",
"in",
"object",
"in",
"its",
"existing",
"context",
"."
] | def _verifyObjectPaste(object, validate_src=1):
"""Verify whether the current user is allowed to paste the passed
object into self. This is determined by checking to see if the
user could create a new object of the same meta_type of the
object passed in and checking that the user actually is
allowed to access the passed in object in its existing
context.
Passing a false value for the validate_src argument will skip
checking the passed in object in its existing context. This is
mainly useful for situations where the passed in object has no
existing context, such as checking an object during an import
(the object will not yet have been connected to the
acquisition hierarchy).
""" | [
"def",
"_verifyObjectPaste",
"(",
"object",
",",
"validate_src",
"=",
"1",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L620-L634 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IObjectManager.filtered_meta_types | (user=None) | Return a list of the types for which the user has adequate
permission to add that type of object. | Return a list of the types for which the user has adequate
permission to add that type of object. | [
"Return",
"a",
"list",
"of",
"the",
"types",
"for",
"which",
"the",
"user",
"has",
"adequate",
"permission",
"to",
"add",
"that",
"type",
"of",
"object",
"."
] | def filtered_meta_types(user=None):
"""Return a list of the types for which the user has adequate
permission to add that type of object.
""" | [
"def",
"filtered_meta_types",
"(",
"user",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L670-L673 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IObjectManager.hasObject | (id) | Indicate whether the folder has an item by ID. | Indicate whether the folder has an item by ID. | [
"Indicate",
"whether",
"the",
"folder",
"has",
"an",
"item",
"by",
"ID",
"."
] | def hasObject(id):
"""Indicate whether the folder has an item by ID.
""" | [
"def",
"hasObject",
"(",
"id",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L695-L697 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IObjectManager.objectIds | (spec=None) | List the IDs of the subobjects of the current object.
If 'spec' is specified, returns only objects whose meta_types match
'spec'. | List the IDs of the subobjects of the current object. | [
"List",
"the",
"IDs",
"of",
"the",
"subobjects",
"of",
"the",
"current",
"object",
"."
] | def objectIds(spec=None):
"""List the IDs of the subobjects of the current object.
If 'spec' is specified, returns only objects whose meta_types match
'spec'.
""" | [
"def",
"objectIds",
"(",
"spec",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L699-L704 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IObjectManager.objectValues | (spec=None) | List the subobjects of the current object.
If 'spec' is specified, returns only objects whose meta_types match
'spec'. | List the subobjects of the current object. | [
"List",
"the",
"subobjects",
"of",
"the",
"current",
"object",
"."
] | def objectValues(spec=None):
"""List the subobjects of the current object.
If 'spec' is specified, returns only objects whose meta_types match
'spec'.
""" | [
"def",
"objectValues",
"(",
"spec",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L706-L711 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IObjectManager.objectItems | (spec=None) | List (ID, subobject) tuples for subobjects of the current object.
If 'spec' is specified, returns only objects whose meta_types match
'spec'. | List (ID, subobject) tuples for subobjects of the current object. | [
"List",
"(",
"ID",
"subobject",
")",
"tuples",
"for",
"subobjects",
"of",
"the",
"current",
"object",
"."
] | def objectItems(spec=None):
"""List (ID, subobject) tuples for subobjects of the current object.
If 'spec' is specified, returns only objects whose meta_types match
'spec'.
""" | [
"def",
"objectItems",
"(",
"spec",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L713-L718 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IObjectManager.objectMap | () | Return a tuple of mappings containing subobject meta-data. | Return a tuple of mappings containing subobject meta-data. | [
"Return",
"a",
"tuple",
"of",
"mappings",
"containing",
"subobject",
"meta",
"-",
"data",
"."
] | def objectMap():
"""Return a tuple of mappings containing subobject meta-data.
""" | [
"def",
"objectMap",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L720-L722 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IObjectManager.superValues | (t) | Return all of the objects of a given type located in this object
and containing objects. | Return all of the objects of a given type located in this object
and containing objects. | [
"Return",
"all",
"of",
"the",
"objects",
"of",
"a",
"given",
"type",
"located",
"in",
"this",
"object",
"and",
"containing",
"objects",
"."
] | def superValues(t):
"""Return all of the objects of a given type located in this object
and containing objects.
""" | [
"def",
"superValues",
"(",
"t",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L724-L727 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IObjectManager.manage_delObjects | (ids=[], REQUEST=None) | Delete a subordinate object
The objects specified in 'ids' get deleted. | Delete a subordinate object | [
"Delete",
"a",
"subordinate",
"object"
] | def manage_delObjects(ids=[], REQUEST=None):
"""Delete a subordinate object
The objects specified in 'ids' get deleted.
""" | [
"def",
"manage_delObjects",
"(",
"ids",
"=",
"[",
"]",
",",
"REQUEST",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L729-L733 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IObjectManager.tpValues | () | Return a list of subobjects, used by tree tag. | Return a list of subobjects, used by tree tag. | [
"Return",
"a",
"list",
"of",
"subobjects",
"used",
"by",
"tree",
"tag",
"."
] | def tpValues():
"""Return a list of subobjects, used by tree tag.
""" | [
"def",
"tpValues",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L735-L737 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IObjectManager.manage_exportObject | (id='', download=None,
RESPONSE=None, REQUEST=None) | Exports an object to a file and returns that file. | Exports an object to a file and returns that file. | [
"Exports",
"an",
"object",
"to",
"a",
"file",
"and",
"returns",
"that",
"file",
"."
] | def manage_exportObject(id='', download=None,
RESPONSE=None, REQUEST=None):
"""Exports an object to a file and returns that file.""" | [
"def",
"manage_exportObject",
"(",
"id",
"=",
"''",
",",
"download",
"=",
"None",
",",
"RESPONSE",
"=",
"None",
",",
"REQUEST",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L739-L741 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IObjectManager.manage_importObject | (file, REQUEST=None, set_owner=1) | Import an object from a file | Import an object from a file | [
"Import",
"an",
"object",
"from",
"a",
"file"
] | def manage_importObject(file, REQUEST=None, set_owner=1):
"""Import an object from a file""" | [
"def",
"manage_importObject",
"(",
"file",
",",
"REQUEST",
"=",
"None",
",",
"set_owner",
"=",
"1",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L743-L744 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IFindSupport.ZopeFind | (obj, obj_ids=None, obj_metatypes=None,
obj_searchterm=None, obj_expr=None,
obj_mtime=None, obj_mspec=None,
obj_permission=None, obj_roles=None,
search_sub=0,
REQUEST=None, result=None, pre='') | Zope Find interface | Zope Find interface | [
"Zope",
"Find",
"interface"
] | def ZopeFind(obj, obj_ids=None, obj_metatypes=None,
obj_searchterm=None, obj_expr=None,
obj_mtime=None, obj_mspec=None,
obj_permission=None, obj_roles=None,
search_sub=0,
REQUEST=None, result=None, pre=''):
"""Zope Find interface""" | [
"def",
"ZopeFind",
"(",
"obj",
",",
"obj_ids",
"=",
"None",
",",
"obj_metatypes",
"=",
"None",
",",
"obj_searchterm",
"=",
"None",
",",
"obj_expr",
"=",
"None",
",",
"obj_mtime",
"=",
"None",
",",
"obj_mspec",
"=",
"None",
",",
"obj_permission",
"=",
"None",
",",
"obj_roles",
"=",
"None",
",",
"search_sub",
"=",
"0",
",",
"REQUEST",
"=",
"None",
",",
"result",
"=",
"None",
",",
"pre",
"=",
"''",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L756-L762 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IFindSupport.ZopeFindAndApply | (obj, obj_ids=None, obj_metatypes=None,
obj_searchterm=None, obj_expr=None,
obj_mtime=None, obj_mspec=None,
obj_permission=None, obj_roles=None,
search_sub=0,
REQUEST=None, result=None, pre='',
apply_func=None, apply_path='') | Zope Find interface and apply | Zope Find interface and apply | [
"Zope",
"Find",
"interface",
"and",
"apply"
] | def ZopeFindAndApply(obj, obj_ids=None, obj_metatypes=None,
obj_searchterm=None, obj_expr=None,
obj_mtime=None, obj_mspec=None,
obj_permission=None, obj_roles=None,
search_sub=0,
REQUEST=None, result=None, pre='',
apply_func=None, apply_path=''):
"""Zope Find interface and apply""" | [
"def",
"ZopeFindAndApply",
"(",
"obj",
",",
"obj_ids",
"=",
"None",
",",
"obj_metatypes",
"=",
"None",
",",
"obj_searchterm",
"=",
"None",
",",
"obj_expr",
"=",
"None",
",",
"obj_mtime",
"=",
"None",
",",
"obj_mspec",
"=",
"None",
",",
"obj_permission",
"=",
"None",
",",
"obj_roles",
"=",
"None",
",",
"search_sub",
"=",
"0",
",",
"REQUEST",
"=",
"None",
",",
"result",
"=",
"None",
",",
"pre",
"=",
"''",
",",
"apply_func",
"=",
"None",
",",
"apply_path",
"=",
"''",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L764-L771 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IPropertyManager.hasProperty | (id) | Return true if object has a property 'id'. | Return true if object has a property 'id'. | [
"Return",
"true",
"if",
"object",
"has",
"a",
"property",
"id",
"."
] | def hasProperty(id):
"""Return true if object has a property 'id'.
""" | [
"def",
"hasProperty",
"(",
"id",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L854-L856 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IPropertyManager.getProperty | (id, d=None) | Get the property 'id'.
Returns the optional second argument or None if no such property is
found. | Get the property 'id'. | [
"Get",
"the",
"property",
"id",
"."
] | def getProperty(id, d=None):
"""Get the property 'id'.
Returns the optional second argument or None if no such property is
found.
""" | [
"def",
"getProperty",
"(",
"id",
",",
"d",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L858-L863 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IPropertyManager.getPropertyType | (id) | Get the type of property 'id'.
Returns None if no such property exists. | Get the type of property 'id'. | [
"Get",
"the",
"type",
"of",
"property",
"id",
"."
] | def getPropertyType(id):
"""Get the type of property 'id'.
Returns None if no such property exists.
""" | [
"def",
"getPropertyType",
"(",
"id",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L865-L869 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IPropertyManager._wrapperCheck | (object) | Raise an error if an object is wrapped. | Raise an error if an object is wrapped. | [
"Raise",
"an",
"error",
"if",
"an",
"object",
"is",
"wrapped",
"."
] | def _wrapperCheck(object):
"""Raise an error if an object is wrapped.
""" | [
"def",
"_wrapperCheck",
"(",
"object",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L871-L873 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IPropertyManager._setProperty | (id, value, type='string') | Set property.
For selection and multiple selection properties the value argument
indicates the select variable of the property. | Set property. | [
"Set",
"property",
"."
] | def _setProperty(id, value, type='string'):
"""Set property.
For selection and multiple selection properties the value argument
indicates the select variable of the property.
""" | [
"def",
"_setProperty",
"(",
"id",
",",
"value",
",",
"type",
"=",
"'string'",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L883-L888 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IPropertyManager._updateProperty | (id, value) | Update the value of an existing property.
If value is a string, an attempt will be made to convert the value to
the type of the existing property. | Update the value of an existing property. | [
"Update",
"the",
"value",
"of",
"an",
"existing",
"property",
"."
] | def _updateProperty(id, value):
"""Update the value of an existing property.
If value is a string, an attempt will be made to convert the value to
the type of the existing property.
""" | [
"def",
"_updateProperty",
"(",
"id",
",",
"value",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L890-L895 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IPropertyManager.propertyIds | () | Return a list of property ids. | Return a list of property ids. | [
"Return",
"a",
"list",
"of",
"property",
"ids",
"."
] | def propertyIds():
"""Return a list of property ids.
""" | [
"def",
"propertyIds",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L901-L903 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IPropertyManager.propertyValues | () | Return a list of actual property objects. | Return a list of actual property objects. | [
"Return",
"a",
"list",
"of",
"actual",
"property",
"objects",
"."
] | def propertyValues():
"""Return a list of actual property objects.
""" | [
"def",
"propertyValues",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L905-L907 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IPropertyManager.propertyItems | () | Return a list of (id,property) tuples. | Return a list of (id,property) tuples. | [
"Return",
"a",
"list",
"of",
"(",
"id",
"property",
")",
"tuples",
"."
] | def propertyItems():
"""Return a list of (id,property) tuples.
""" | [
"def",
"propertyItems",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L909-L911 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IPropertyManager._propertyMap | () | Return a tuple of mappings, giving meta-data for properties. | Return a tuple of mappings, giving meta-data for properties. | [
"Return",
"a",
"tuple",
"of",
"mappings",
"giving",
"meta",
"-",
"data",
"for",
"properties",
"."
] | def _propertyMap():
"""Return a tuple of mappings, giving meta-data for properties.
""" | [
"def",
"_propertyMap",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L913-L915 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IPropertyManager.propertyMap | () | Return a tuple of mappings, giving meta-data for properties.
Return copies of the real definitions for security. | Return a tuple of mappings, giving meta-data for properties. | [
"Return",
"a",
"tuple",
"of",
"mappings",
"giving",
"meta",
"-",
"data",
"for",
"properties",
"."
] | def propertyMap():
"""Return a tuple of mappings, giving meta-data for properties.
Return copies of the real definitions for security.
""" | [
"def",
"propertyMap",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L917-L921 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IPropertyManager.propertyLabel | (id) | Return a label for the given property id | Return a label for the given property id | [
"Return",
"a",
"label",
"for",
"the",
"given",
"property",
"id"
] | def propertyLabel(id):
"""Return a label for the given property id
""" | [
"def",
"propertyLabel",
"(",
"id",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L923-L925 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IPropertyManager.manage_addProperty | (id, value, type, REQUEST=None) | Add a new property via the web.
Sets a new property with the given id, type, and value. | Add a new property via the web. | [
"Add",
"a",
"new",
"property",
"via",
"the",
"web",
"."
] | def manage_addProperty(id, value, type, REQUEST=None):
"""Add a new property via the web.
Sets a new property with the given id, type, and value.
""" | [
"def",
"manage_addProperty",
"(",
"id",
",",
"value",
",",
"type",
",",
"REQUEST",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L933-L937 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IPropertyManager.manage_editProperties | (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. | Edit object properties via the web. | [
"Edit",
"object",
"properties",
"via",
"the",
"web",
"."
] | def manage_editProperties(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.
""" | [
"def",
"manage_editProperties",
"(",
"REQUEST",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L939-L946 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IPropertyManager.manage_changeProperties | (REQUEST=None, **kw) | Change existing object properties.
Change object properties by passing either a REQUEST object or
name=value parameters | Change existing object properties. | [
"Change",
"existing",
"object",
"properties",
"."
] | def manage_changeProperties(REQUEST=None, **kw):
"""Change existing object properties.
Change object properties by passing either a REQUEST object or
name=value parameters
""" | [
"def",
"manage_changeProperties",
"(",
"REQUEST",
"=",
"None",
",",
"*",
"*",
"kw",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L948-L953 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IPropertyManager.manage_changePropertyTypes | (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. | Replace one set of properties with another | [
"Replace",
"one",
"set",
"of",
"properties",
"with",
"another"
] | def manage_changePropertyTypes(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.
""" | [
"def",
"manage_changePropertyTypes",
"(",
"old_ids",
",",
"props",
",",
"REQUEST",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L955-L962 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IPropertyManager.manage_delProperties | (ids=None, REQUEST=None) | Delete one or more properties specified by 'ids'. | Delete one or more properties specified by 'ids'. | [
"Delete",
"one",
"or",
"more",
"properties",
"specified",
"by",
"ids",
"."
] | def manage_delProperties(ids=None, REQUEST=None):
"""Delete one or more properties specified by 'ids'.""" | [
"def",
"manage_delProperties",
"(",
"ids",
"=",
"None",
",",
"REQUEST",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L964-L965 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IApplication.Redirect | (destination, URL1) | Utility function to allow user-controlled redirects | Utility function to allow user-controlled redirects | [
"Utility",
"function",
"to",
"allow",
"user",
"-",
"controlled",
"redirects"
] | def Redirect(destination, URL1):
"""Utility function to allow user-controlled redirects""" | [
"def",
"Redirect",
"(",
"destination",
",",
"URL1",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L997-L998 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IApplication.__bobo_traverse__ | (REQUEST, name=None) | Bobo traverse. | Bobo traverse. | [
"Bobo",
"traverse",
"."
] | def __bobo_traverse__(REQUEST, name=None):
"""Bobo traverse.
""" | [
"def",
"__bobo_traverse__",
"(",
"REQUEST",
",",
"name",
"=",
"None",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L1002-L1004 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IApplication.ZopeTime | (*args) | Utility function to return current date/time | Utility function to return current date/time | [
"Utility",
"function",
"to",
"return",
"current",
"date",
"/",
"time"
] | def ZopeTime(*args):
"""Utility function to return current date/time""" | [
"def",
"ZopeTime",
"(",
"*",
"args",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L1006-L1007 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IApplication.absolute_url | (relative=0) | The absolute URL of the root object is BASE1 or "/". | The absolute URL of the root object is BASE1 or "/". | [
"The",
"absolute",
"URL",
"of",
"the",
"root",
"object",
"is",
"BASE1",
"or",
"/",
"."
] | def absolute_url(relative=0):
"""The absolute URL of the root object is BASE1 or "/".
""" | [
"def",
"absolute_url",
"(",
"relative",
"=",
"0",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L1009-L1011 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IApplication.absolute_url_path | () | The absolute URL path of the root object is BASEPATH1 or "/". | The absolute URL path of the root object is BASEPATH1 or "/". | [
"The",
"absolute",
"URL",
"path",
"of",
"the",
"root",
"object",
"is",
"BASEPATH1",
"or",
"/",
"."
] | def absolute_url_path():
"""The absolute URL path of the root object is BASEPATH1 or "/".
""" | [
"def",
"absolute_url_path",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L1013-L1015 |
||
zopefoundation/Zope | 61260fab5776ea4c8bbbb0129d729d05eb183c4c | src/OFS/interfaces.py | python | IApplication.virtual_url_path | () | The virtual URL path of the root object is empty. | The virtual URL path of the root object is empty. | [
"The",
"virtual",
"URL",
"path",
"of",
"the",
"root",
"object",
"is",
"empty",
"."
] | def virtual_url_path():
"""The virtual URL path of the root object is empty.
""" | [
"def",
"virtual_url_path",
"(",
")",
":"
] | https://github.com/zopefoundation/Zope/blob/61260fab5776ea4c8bbbb0129d729d05eb183c4c/src/OFS/interfaces.py#L1017-L1019 |