Sets the sort priority of the entity currently referenced by this iterator object.
eOk if successful or the appropriate error code otherwise.
This method can return the following: